StockSettings: Get and Set SAG Chart Settings

View source: R/StockSettings.R

getsetStockChartSettingsR Documentation

Get and Set SAG Chart Settings

Description

details

Usage

StockSettings(assessmentKey, ...)

setStockSettings(
  assessmentKey,
  chartKey,
  settingKey,
  settingValue,
  copyNextYear,
  ...
)

Arguments

assessmentKey

the unique identifier of the stock assessment

...

arguments passed to ices_get.

chartKey

the type identifier of the SAG chart, e.g. 0, 1, 2, ...

settingKey

the type identifier of the SAG chart setting, e.g. 0, 1, 2, ...

settingValue

the vale of the setting

copyNextYear

should the settings be copied to next year (TRUE) or not (FALSE)

Value

A data frame with SAG chart type IDs, settings IDs and setting values.

Examples

## Not run: 
assessmentKey <- findAssessmentKey("had.27.46a20", year = 2022)

StockSettings(assessmentKey)

## End(Not run)

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