get_tag_colours: Get tag colour options - A list of tag colour codes used in...

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

Get tag colour options - A list of tag colour codes used in GLIS

Description

This function accesses the api endpoint for tag colour choices and returns their labels, descriptions and whether they're in use. It fetches the entire table of accepted tag colours - no other filter parameters are currently available for this endpoint. Tag colour is the fifth character of TAGDOC.

Usage

get_tag_colours(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/tag_colours/ for the full list of tag colour options

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

tag_colours <- get_tag_colours()
tag_colour_slugs <- get_tag_colours(show_id = TRUE)

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