get_SC023: Get SC023 - Day Type Data Creel_Portal API

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

Get SC023 - Day Type Data Creel_Portal API

Description

This function accesses the api endpoint for SC023 records. SC023 records contain information about the day types considered in a creel and the codes used to identify those days. Days are usually identified as either weekday, or weekend days. (the SC025 end point is used to identify exception dates - weekdays that should be treated like a weekend).

Usage

get_SC023(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("sc023") 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 "sc023" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

sc023 <- get_SC023(list(lake = "ON", year = 2012))

sc023 <- get_SC023(list(prj_cd = "LHA_IA19_812"))
sc023 <- get_SC023(list(prj_cd = "LHA_IA19_812"), show_id = TRUE)

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