get_pt_projects: get_pt_projects - Project Tracker Projects

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

get_pt_projects - Project Tracker Projects

Description

This function accesses the api endpoint to for projects in 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_filters("projects") to see the full list of available filters. This function returns a dataframe containing attributes of the project including project code, project name, start and end date, and project lead.

Usage

get_pt_projects(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

projects <- get_pt_projects(list(
  lake = "ON", year__gte = 2016,
  year__lte = 2018
))

projects <- get_pt_projects(list(
  lake = "HU", year__gte = 2018,
  prj_cd__like = "006"
))

projects <- get_pt_projects(list(lake = "ER", year__gte = 2018))

filters <- list(lake = "SU", prj_cd = c("LSA_IA15_CIN", "LSA_IA17_CIN"))
projects <- get_pt_projects(filters)

projects <- get_pt_projects(list(lake = "HU", year__gte = 2018))

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