get_Stream_Dimensions: Get Stream Dimensions data from FN_Portal API

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

Get Stream Dimensions data from FN_Portal API

Description

This function accesses the api endpoint for Stream_Dimensions records. Stream_Dimensions records contain information about streams and rivers in which electrofishing transects take place, including the distance from the start of the transect, the distance across the channel, and stream depth, width, and velocity. Other relevant details for the SUBSPACE are found in the FN121 table. This function takes an optional filter list which can be used to return records based on attributes of the project including project code, or part of the project code, lake, first year, last year, protocol, etc.

Usage

get_Stream_Dimensions(filter_list = list(), show_id = FALSE, to_upper = TRUE)

Arguments

filter_list	list
show_id	When 'FALSE', the default, the 'slug' field is hidden from the data frame. To return this field 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("stream_dimensions") to see the full list of available filter keys (query parameters). Refer to https://intra.glis.mnr.gov.on.ca/fn_portal/api/v1/swagger/ and filter by "stream_dimensions" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

## Not run: 
show_filters("stream_dimensions")

## End(Not run)
# TODO: add more examples when more data is uploaded
stream <- get_Stream_Dimensions(list(lake = "ER"))

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