get_FN121_GPS_Tracks: Get FN121_GPS - GPS data from FN_Portal API

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

Get FN121_GPS - GPS data from FN_Portal API

Description

This function accesses the api endpoint for FN121_GPS_Tracks records. FN121_GPS_Tracks records contain GPS tracks for projects where GPS data is recorded (e.g. trawls, electrofishing, etc.), including the track ID, coordinates in decimal decrees, the timestamp and site depth. Other relevant details for each SAM 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 SAM including site depth, timestamp, start and end date and time, effort duration, gear, site depth and location as well as attributes of the projects they are associated with such project code, or part of the project code, lake, first year, last year, protocol, etc.

Usage

get_FN121_GPS_Tracks(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("fn121_gps_tracks") 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 "fn121_gps_tracks" for additional information.

Value

dataframe

Author(s)

Adam Cottrill [e-mail]

Examples

# TODO: Update with relevant examples when more data exists in the portal

fn121_gps <- get_FN121_GPS_Tracks(list(lake = "HU", prj_cd__like = "_306"))
fn121_gps <- get_FN121_GPS_Tracks(list(lake = "HU", prj_cd__like = "_306"), show_id = TRUE)

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