get_cover_types: Get cover types - A list of cover types used in GLIS

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

Get cover types - A list of cover types used in GLIS

Description

This function accesses the api endpoint for cover types and returns their names, descriptions and whether they're in use. It can fetch the entire table of accepted cover type codes, or it accepts filter parameter all=TRUE to return depreciated cover type codes too. No other filter parameters are currently available for this endpoint.

Usage

get_cover_types(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/cover_types/ for the full list of cover types

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

cover_types <- get_cover_types()
all_cover_types <- get_cover_types(list(all = TRUE))
cover_type_slugs <- get_cover_types(show_id = TRUE)

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