get_gear: Get Gear List from the FN_Portal API

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

Get Gear List from the FN_Portal API

Description

This function returns basic details about fishing gear(s) from the FN_Prortal api. Use get_gear_process_types() for more detail about the corresponding process type

Usage

get_gear(filter_list = list(), show_id = FALSE, to_upper = TRUE)

Arguments

filter_list	list
show_id	When 'FALSE', the default, the 'id' and 'slug' fields are hidden from the data frame. To return these columns as part of the data frame, use 'show_id = TRUE'.
to_upper	should the names of the dataframe be converted to upper case?

Details

Use show_filters("gear") to see the full list of available filter keys (query parameters). Refer to https://intra.glis.mnr.gov.on.ca/fn_portal/api/v1/swagger/ and filter by "gear" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

GL10 <- get_gear(list(gr = "GL10"))
GL_n <- get_gear(list(gr = c("GL10", "GL21")))
GL1x <- get_gear(list(gr__like = "GL1"))

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