get_RMIS_data: get_RMIS_data

View source: R/get_RMIS_data.R

get_RMIS_dataR Documentation

get_RMIS_data

Description

get_RMIS_data downloads data from the RMIS API returning data for the specified agency and module. Restricted to returning a maximum of 1000 records. If 1000 records are returned, more data should exist on subsequent pages (Recommendation: increment your page argument).

Usage

get_RMIS_data(
  api_key,
  agency = c("NPT", "ADFG", "CCT", "CDFO", "CDFW", "CDFWKT", "CRITFC", "IDFG", "NMFS",
    "NMFSNWR", "NWIFC", "ODFW", "QDNR", "QUIL", "RMPC", "STIL", "USFWS", "WDFW", "YAKA",
    "YTFP"),
  module = c("release", "location", "files", "recovery", "catchsample", "description"),
  page = 1,
  perpage = 1000
)

Arguments

api_key

unique access key obtained from RMIS.

agency

desired return agency

module

desired module to get data from

page

desired page to return (default: 1)

perpage

Number of records returned 1-1000 (default: 1000)

Value

data frame containing RMIS data from selected module


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