get_bottom_types: Get bottom types - A list of bottom types used in GLIS

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

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

Description

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

Usage

get_bottom_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/bottom_types/ for the full list of bottom types

Value

dataframe

Author(s)

Rachel Henderson [e-mail]

Examples

bottom_types <- get_bottom_types()
all_bottom_types <- get_bottom_types(list(all = TRUE))
bottom_type_slugs <- get_bottom_types(show_id = TRUE)

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