get_SC121: Get SC121 - Angler Interviews from Creel_Portal API

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

Get SC121 - Angler Interviews from Creel_Portal API

Description

This function accesses the api endpoint to for SC121 records. SC121 records contain information about interviews with anglers conducted during a creel survey. The SC121 records contain information like the number of anglers in there party, when the started fishing and often answers to creel specific optional questions. This function takes an optional filter list which can be used to return record based on several attributes of the interview.

Usage

get_SC121(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("sc121") 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 "sc121" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

sc121 <- get_SC121(list(lake = "HU", year = 2009))

sc121 <- get_SC121(list(lake = "HU", prj_cd__like = "_001", year = 2009))
sc121 <- get_SC121(list(lake = "HU", prj_cd__like = "_001", year = 2009), show_id = TRUE)

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