get_pt_points: get_pt_points - Project Tracker Points

In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

get_pt_points - Project Tracker Points

Description

This function accesses the api endpoint to for sampling points that have been uploaded into project tracker. This api endpoint accepts a large number of filters associated with the project including spatial filters for buffered point, or region of interest. Project specific filters include project code(s), years, lakes, and project lead. Use 'show_filter("points")' to see the full list of available filters. This function returns a data frame containing attributes of project including project code, project project type, dd_lat and dd_lon.

Usage

get_pt_points(filter_list = list(), to_upper = TRUE)

Arguments

filter_list	list
to_upper	should the names of the returned dataframe be converted to upper case?

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

points <- get_pt_points(list(
  lake = "ON", year__gte = 2012,
  year__lte = 2018
))

points <- get_pt_points(list(
  lake = "HU", year__gte = 2012,
  prj_cd__like = "006"
))

filters <- list(lake = "SU", prj_cd__like = "TEL")
points <- get_pt_points(filters)

AdamCottrill/glfishr documentation built on Aug. 9, 2024, 5:47 p.m.