get_FN012: Get FN012 - Sampling specs (species and group) from FN_Portal...

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

Get FN012 - Sampling specs (species and group) from FN_Portal API

Description

This function accesses the api endpoint for FN012 records. FN012 records contain a list of anticipated species for a project and the likely length and weight ranges for those species. These constraints are used by ProcVal to check that biodata for fish caught during the project is reasonable. The FN012 records contain information like minimum and maximum TLEN, FLEN, RWT, and K values for each species. This function takes an optional filter list which can be used to return records based on several attributes of the project such as protocol, lake, project code, and species.

Usage

get_FN012(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("fn012") 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 "fn012" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

fn012 <- get_FN012(list(lake = "HU"))

filters <- list(lake = "HU", prj_cd = c("LHA_IA21_823", "LHA_IA20_812"))
fn012 <- get_FN012(filters)

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