get_SC124: Get SC124 - Length Frequency Counts from Creel_Portal API

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

Get SC124 - Length Frequency Counts from Creel_Portal API

Description

This function accesses the api endpoint for SC124 records from the Creel_Portal. SC124 records contain information about the length frequency by species associated with an angler interview. Group (GRP) is occasionally included to further sub-divide the catch into user defined groups that are usually specific to the project. This function takes an optional filter list which can be used to return record based on several attributes of the catch including species or group code but also attributes of the effort, the sample or the project(s) that the catches were made in.

Usage

get_SC124(
  filter_list = list(),
  show_id = FALSE,
  to_upper = TRUE,
  uncount = FALSE
)

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 data-frame be converted to upper case?
uncount	should the binned data be expanded to represent individual measurements. A SC124 record with sizcnt=5 will be repeated 5 times in the returned data frame.

Details

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

Value

dataframe

Author(s)

Jeremy Holden [e-mail]

Examples

sc124 <- get_SC124(list(lake = "ON", year = 2021, spc = "334"))

filters <- list(
  lake = "ON",
  year = 2021,
  spc = c("061", "121")
)
sc124 <- get_SC124(filters)

sc124 <- get_SC124(list(prj_cd = "LOA_SC19_002"),
  uncount = TRUE
)

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