get_Angler_Questions: Get Angler Questions from Creel Portal API

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

Get Angler Questions from Creel Portal API

Description

This function accesses the api endpoint for Angler Questions. Angler Question records contain the extra questions that were asked during creels. The question number corresponds with the ANGOP# fields in the FN121 table. This function takes an optional filter list which can be used to return records based on the question text, number, and several attributes of the project such as project code, or part of the project code, lake, first year, last year, etc.

Usage

get_Angler_Questions(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("angler_questions") 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 "angler_questions" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

questions_05_15 <- get_Angler_Questions(list(year__gte = 2005, year__lte = 2015))

trout_questions <- get_Angler_Questions(list(question_text__like = "trout"))

questions_saugeen <- get_Angler_Questions(list(lake = "HU", prj_cd__like = "DR"))

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