findAssessmentKeydocs: Find a Key

In icesSAG: Stock Assessment Graphs Database Web Services

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)

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.

Value

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

Author(s)

Arni Magnusson and Colin Millar.

See Also

getListStocks gets a list of stocks.

icesSAG-package gives an overview of the package.

Examples

## Not run: 
findAssessmentKey("cod-347d", 2015, full = TRUE)

## End(Not run)

icesSAG documentation built on May 31, 2023, 6:46 p.m.