get_ageprep1: Get age preparation 1 options - A list of age preparation 1...
In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal
get_ageprep1 R Documentation
Get age preparation 1 options - A list of age preparation 1 codes used in GLIS
Description
This function accesses the api endpoint for age preparation 1 choices and returns
their labels, descriptions and whether they're in use. It fetches the entire
table of valid age preparation 1 codes - no other
filter parameters are currently available for this endpoint.
Usage
get_ageprep1(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
Note that age preparation 1 codes are valid for the second
character of the AGEMT field.
See
https://intra.glis.mnr.gov.on.ca/common/ageprep1/
for the full list of age preparation 1 code options
Value
dataframe
Author(s)
Rachel Henderson rachel.henderson@ontario.ca
Examples
ageprep1 <- get_ageprep1()
ageprep1_slugs <- get_ageprep1(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.
| get_ageprep1 | R Documentation |
Get age preparation 1 options - A list of age preparation 1 codes used in GLIS
Description
This function accesses the api endpoint for age preparation 1 choices and returns their labels, descriptions and whether they're in use. It fetches the entire table of valid age preparation 1 codes - no other filter parameters are currently available for this endpoint.
Usage
get_ageprep1(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
Note that age preparation 1 codes are valid for the second character of the AGEMT field.
See https://intra.glis.mnr.gov.on.ca/common/ageprep1/ for the full list of age preparation 1 code options
Value
dataframe
Author(s)
Rachel Henderson rachel.henderson@ontario.ca
Examples
ageprep1 <- get_ageprep1()
ageprep1_slugs <- get_ageprep1(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.