get_FN125: Get FN125 - Biological data from FN_Portal API

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

Get FN125 - Biological data from FN_Portal API

Description

This function accesses the api endpoint to for FN125 records. FN125 records contain the biological data collected from individual fish sampled in assessment projects such as length, weight, sex, and maturity. For convenience this end point also returns data from child tables such as the 'preferred' age, and lamprey wounds. This function takes an optional filter list which can be used to return records based on several different biological attributes (such as size, sex, or maturity), but also of the species, or group code, or attributes of the effort, the sample, or the project(s) that the samples were collected in.

Usage

get_FN125(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("fn125") 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 "fn125" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

fn125 <- get_FN125(list(lake = "ON", year = 2012, spc = "334", gr = "GL"))

filters <- list(
  lake = "ER",
  protocol = "TWL",
  spc = c("331", "334"),
  sidep0__lte = 20
)
fn125 <- get_FN125(filters)


filters <- list(
  lake = "SU",
  prj_cd = c("LSA_IA15_CIN", "LSA_IA17_CIN"),
  eff = "051",
  spc = "091"
)
fn125 <- get_FN125(filters)

filters <- list(lake = "HU", spc = "076", grp = "55")
fn125 <- get_FN125(filters)

fn125 <- get_FN125(list(prj_cd = "LHA_IA19_812"))
fn125 <- get_FN125(list(prj_cd = "LHA_IA19_812"), show_id = TRUE)

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