get_SC026_Subspace: Get SC026_Subspace - Spatial Strata Data Creel_Portal API

View source: R/get_SC026_Subspace.R

get_SC026_SubspaceR Documentation

Get SC026_Subspace - Spatial Strata Data Creel_Portal API

Description

This function accesses the api endpoint to for SC026_Subspace records. SC026_Subspace records contain information about the lower level spatial strata associated with a project.

Usage

get_SC026_Subspace(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("sc026subspace") 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 "sc026subspace" for additional information.

Value

dataframe

Author(s)

Adam Cottrill adam.cottrill@ontario.ca

Examples


sc026_subspace <- get_SC026_Subspace(list(lake = "ON", year = 2012))

sc026_subspace <- get_SC026_Subspace(list(prj_cd = "LHA_SC03_220"))
sc026_subspace <- get_SC026_Subspace(list(prj_cd = "LHA_SC03_220"), show_id = TRUE)

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