get_orientations: Get orientation options - A list of orientation codes used in...

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

Get orientation options - A list of orientation codes used in GLIS

Description

This function accesses the api endpoint for orientation choices and returns their labels, descriptions and whether they're in use. It fetches the entire table of orientation codes - no other filter parameters are currently available for this endpoint.

Usage

get_orientations(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/orient/ for the full list of orientation code options

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

orientations <- get_orientations()
orientation_slugs <- get_orientations(show_id = TRUE)

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