icesSAG (version 1.4.1)

findAssessmentKey: Find a Key

Description

Find a lookup key corresponding to a stock in a given assessment year.

Usage

findAssessmentKey(
  stock = NULL,
  year = 0,
  published = TRUE,
  regex = TRUE,
  full = FALSE
)
findKey(stock, year = 0, published = TRUE, regex = TRUE, full = FALSE)

Value

A vector of keys (default) or a data frame if full is TRUE.

Arguments

stock

a stock name, e.g. cod-347d, or cod to find all cod stocks, or NULL (default) to process all stocks.

year

the assessment year, e.g. 2015, or 0 to process all years.

published

whether to include only years where status is "Published" (applies only when non-secure web services are in use, secure web service always returns unpublished stocks).

regex

whether to match the stock name as a regular expression.

full

whether to return a data frame with all stock list columns.

Author

Arni Magnusson and Colin Millar.

See Also

getListStocks gets a list of stocks.

icesSAG-package gives an overview of the package.

Examples

if (FALSE) {
findAssessmentKey("cod-347d", 2015, full = TRUE)
}