get_grid5s: Get 5-minute grids - A list of 5-minute grids for the Great...
In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

get_grid5s

R Documentation

Get 5-minute grids - A list of 5-minute grids for the Great Lakes

Description

This function accesses the api endpoint for 5-minute grids and returns their number and the corresponding lake. It can fetch the entire table, or it accepts a filter parameter for lake. The filter parameters 'page' and 'page_size' are also accepted. No other filter parameters are currently available for this endpoint.

Usage

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

Arguments

`filter_list`	list
`show_id`	include the fields the 'id' and 'slug' in the returned data frame
`to_upper`	should the names of the dataframe be converted to upper case?

Details

See https://intra.glis.mnr.gov.on.ca/common/grid5s/ for the full list of 5-minute grids

Value

dataframe

Author(s)

Rachel Henderson rachel.henderson@ontario.ca

Examples


grid5s <- get_grid5s(list(page_size = 5000))
erie_grid5s <- get_grid5s(list(lake = "ER"))
grid5_slugs <- get_grid5s(list(page_size = 5000), show_id = TRUE)

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