get_FINSdata: Download data from LSRCP FINS database.

In ryankinzer/fisheR: What the Package Does (One Line, Title Case)

Download data from LSRCP FINS database.

Description

get_FINSdata downloads FINS data from their API using an NPT specific api key. The function can access data from three FINS modules; 'Trapping', 'Release' and 'Spawning'. The user can also specify if only NPT data is required or the full dataset from FINS.

Usage

get_FINSdata(
  module = c("Trapping", "Release", "Spawning"),
  scope = c("NPT", "FINS Domain"),
  startDate,
  endDate,
  api_key
)

Arguments

module	FINS database module to query; Trapping, Release, Spawning.
scope	download NPT data only or the full FINS domain
startDate	query start date formatted as month, day, year; '01/01/2019'
endDate	query end date formatted as month, day, year; '01/01/2020'
api_key	access key supplied from FINS development team.

Value

a data frame of all returned data from FINS query

ryankinzer/fisheR documentation built on June 13, 2024, 6:49 a.m.