getSAG: Get Any SAG Data

In ices-tools-prod/icesSAG: Stock Assessment Graphs Database Web Services

Get Any SAG Data

Description

This function combines the functionality of getListStocks, getFishStockReferencePoints, and getSummaryTable. It supports querying many stocks and years in one function call.

Usage

getSAG(stock, year, data = "summary", combine = TRUE, purpose = "Advice")

Arguments

stock	a stock name, e.g. cod-347d, or cod to find all cod stocks, or NULL to process all stocks.
year	the assessment year, e.g. 2015, or 0 to process all years.
data	the data of interest, either "summary", "refpts" or "source".
combine	whether to combine the list output to a data frame.
purpose	the purpose of the entry, options are "Advice", "Bench", "InitAdvice", default is "Advice".

Value

A data frame (default) or a list if combine is TRUE.

Note

Only years with "Published" status are returned.

Author(s)

Colin Millar.

See Also

StockList, SummaryTable, and FishStockReferencePoints get a list of stocks, summary results, and reference points.

findAssessmentKey finds lookup keys.

icesSAG-package gives an overview of the package.

Examples

## Not run: 
summary <- getSAG("had.27.46a20", 2022)
refpts <- getSAG("had.27.46a20", 2022, "refpts")

cod_summary <- getSAG("cod", 2022)
cod_refpts <- getSAG("cod", 2015:2016, "refpts")
cod_data <- getSAG("cod", 2017, "source-data")

## End(Not run)

ices-tools-prod/icesSAG documentation built on Nov. 24, 2023, 1:55 a.m.