get_SC012_Protocol: Get SC012_Protocol - Creel Sampling specs (species and group)...

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

Get SC012_Protocol - Creel Sampling specs (species and group) for a specific lake and from the Creel_Portal API

Description

This function accesses the api endpoint for SC012 Protocol List records. These records are the expected range of biodata values (e.g. FLEN, TLEN, RWT, K) for the typical species sampled in a creel conducted in a given lake. These constraints are used by ProcVal to check that biodata for fish sampled during the creel is reasonable. This is a useful function for building a template database for a new project or for adding an SC012 table to an existing project.

Usage

get_SC012_Protocol(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("sc012_protocol") to see the full list of available filter keys (query parameters). Refer to https://intra.glis.mnr.gov.on.ca/sc_portal/api/v1/swagger/ and filter by "sc012_protocol" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

sc012_protocol <- get_SC012_Protocol(list(lake = "ON"))

sc012_protocol <- get_SC012_Protocol(list(lake = c("HU", "ER"), protocol = "BSM"))

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