get_fisheries_offices: Get fisheries office options - A list of fisheries office...

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

Get fisheries office options - A list of fisheries office codes used in GLIS

Description

This function accesses the api endpoint for fisheries office choices and returns their labels, descriptions and whether they're in use. It fetches the entire table of accepted fisheries offices - no other filter parameters are currently available for this endpoint. Fisheries office codes represent the first three digits of project code (PRJ_CD).

Usage

get_fisheries_offices(filter_list = list(), show_id = FALSE, to_upper = TRUE)

Arguments

filter_list	list
show_id	include the fields the 'id' and 'slug' in the returned data frame
to_upper	should the names of the dataframe be converted to upper case?

Details

See https://intra.glis.mnr.gov.on.ca/common/fisheries_offices/ for the full list of fisheries_office options

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

fisheries_offices <- get_fisheries_offices()
fisheries_office_slugs <- get_fisheries_offices(show_id = TRUE)

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