get_yreq_factors: Get Yearling Equivalent Factors from Great Lakes Fish...

View source: R/get_yreq_factors.R

get_yreq_factorsR Documentation

Get Yearling Equivalent Factors from Great Lakes Fish Stocking API

Description

This function is a wrapper around api_to_dataframe and calls the api endpoint to retrieve all of the yearling equivalent factors currently in the Great Lakes Fish Stocking database (www.fsis.glfc.org). Yearling equivalent factors are used to adjust the number of fish stocked based on species and lifestage to account for younger life stages that are often stocked in high numbers but also suffer higher mortality. The yearling equivalent factor is intended to standardize the number of fished stocked to the yearling lifestage. The get_yreq_factor() function takes an optional filter list which can be used to return factors for a particular species or life stages.

Usage

get_yreq_factors(filter_list = list())

Arguments

filter_list

list

Details

See http://fsis.glfc.org/api/public_urls/#v1-common-marks-list for the full list of available filter keys (query parameters)

Value

dataframe

Author(s)

Adam Cottrill adam.cottrill@ontario.ca

Examples


get_yreq_factors()
get_yreq_factors(list(species="WAE"))
get_yreq_factors(list(species=c("BNT", "RBT")))
get_yreq_factors(list(lifestage="fry"))
get_yreq_factors(list(lifestage=c("fry", "ff")))

AdamCottrill/GLFishStockR documentation built on Sept. 3, 2022, 10:26 p.m.