get_SC011: Get SC011 - Creel Project Metadata from Creel Portal API

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

Get SC011 - Creel Project Metadata from Creel Portal API

Description

This function accesses the api endpoint for SC011 records. SC011 records contain the high-level meta data about OMNR Creels. The SC011 records contain information like project code, project name, project leader, start and end date, contact method, and the lake where the creel was conducted. This function takes an optional filter list which can be used to return records based on several attributes of the project such as project code, or part of the project code, lake, first year, last year, contact, etc.

Usage

get_SC011(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("sc011") 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 "sc011" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

sc011 <- get_SC011(list(lake = "ON", year__gte = 2012, year__lte = 2018))

sc011 <- get_SC011(list(lake = "ER"))

sc011 <- get_SC011(list(lake = "HU", prj_cd__like = "_001"))

sc011 <- get_SC011(list(lake = "HU", protocol = "USA"), show_id = TRUE)

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