get_gear_process_types: Get Gear Effort Process Types from the FN_Portal API

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

Get Gear Effort Process Types from the FN_Portal API

Description

Process type describes how the catch in a sample is handled - either by net, by mesh size, by groups of panels, or individual panels. The available process types are constrained depending on the gear type. This function returns the known gear, effort and process type combinations from the FN_Portal api, which can then be used to validate FN122 and FN123 records, or used to populate the ProcessEffortGear table in the template database before submitting to Process Validate.

Usage

get_gear_process_types(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_effort_process_types") 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_effort_process_types" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

ptype <- get_gear_process_types(list(gr = "GL10"))
ptype <- get_gear_process_types(list(gr = c("GL10", "GL21")))
ptype <- get_gear_process_types(list(gr__like = "GL1"))

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