get_agest: Get aging structure options - A list of aging structure codes...

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

Get aging structure options - A list of aging structure codes used in GLIS

Description

This function accesses the api endpoint for aging structure choices and returns their labels, descriptions and whether they're in use. It can fetch the entire table of valid aging structures, or it accepts the filter parameter all=TRUE to return all aging structures, including those no longer in use. No other filter parameters are currently available for this endpoint.

Usage

get_agest(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 aging structures are valid for the AGEST field and the first character of the AGEMT field.

See https://intra.glis.mnr.gov.on.ca/common/aging_structures/ for the full list of aging structure code options

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

agest <- get_agest()
agest_all <- get_agest(list(all = TRUE))
agest_slugs <- get_agest(show_id = TRUE)

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