get_clip_codes: Get clip code options - A list of clip codes used in GLIS
In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal
View source: R/get_clip_codes.R
get_clip_codes R Documentation
Get clip code options - A list of clip codes used in GLIS
Description
This function accesses the api endpoint for clip code choices and returns
their labels, descriptions and whether they're in use. It fetches
the entire table of clip codes - no other filter
parameters are currently available for this endpoint. The same list of
clip codes are available for CLIPA and CLIPC.
Usage
get_clip_codes(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/finclips/
for the full list of clip code options
Value
dataframe
Author(s)
Rachel Henderson rachel.henderson@ontario.ca
Examples
clip_codes <- get_clip_codes()
clip_code_slugs <- get_clip_codes(show_id = TRUE)
AdamCottrill/glfishr documentation built on Aug. 9, 2024, 5:47 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/get_clip_codes.R
| get_clip_codes | R Documentation |
Get clip code options - A list of clip codes used in GLIS
Description
This function accesses the api endpoint for clip code choices and returns their labels, descriptions and whether they're in use. It fetches the entire table of clip codes - no other filter parameters are currently available for this endpoint. The same list of clip codes are available for CLIPA and CLIPC.
Usage
get_clip_codes(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 |
|
Details
See https://intra.glis.mnr.gov.on.ca/common/finclips/ for the full list of clip code options
Value
dataframe
Author(s)
Rachel Henderson rachel.henderson@ontario.ca
Examples
clip_codes <- get_clip_codes()
clip_code_slugs <- get_clip_codes(show_id = TRUE)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.