get_pt_nr_milestones: get_pt_nr_milestones - Project Tracker Non-report Milestones

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

get_pt_nr_milestones - Project Tracker Non-report Milestones

Description

This function accesses the api endpoint for non-report milestones in project tracker. This api endpoint accepts a large number of filters associated with the project or milestone type. Project specific filters include project code(s), years, lakes, and project lead. Milestones can also be filtered by their name. Valid milestone types are: "Submitted", "Approved", "Field Work Conducted", "Data Scrubbed", "Aging Complete", "Data Merged", "Sign off", and "Canceled" and can be passed in as a single string or as character vector of one or more milestone types. Use show_filters("project_nr_milestones") to see the full list of available filters. This function returns a data-frame containing attributes of the report, including project code, project name, and the time at which a milestone was completed.

Usage

get_pt_nr_milestones(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]

See Also

fetch_pt_reports()

Examples

milestones <- get_pt_nr_milestones(list(
  lake = "ON", year__gte = 2012,
  year__lte = 2018
))

milestones <- get_pt_nr_milestones(list(
  lake = "HU", year__gte = 2012,
  prj_cd__like = "006", milestone = "Submitted"
))

milestones <- get_pt_nr_milestones(list(lake = "ER"))

filters <- list(lake = "SU", prj_cd = c("LSA_IA15_CIN", "LSA_IA17_CIN"))
milestones <- get_pt_nr_milestones(filters)

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