SS2OM: Reads MLE estimates from Stock Synthesis file structure into...

Description Usage Arguments Details Value Note Author(s) See Also

View source: R/SS2OM.R

Description

A function that uses the file location of a fitted SS3 model including input files to population the various slots of an operating model with MLE parameter estimates. The function mainly populates the Stock and Fleet portions of the operating model; the user still needs to parameterize most of the observation and implementation portions of the operating model.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
SS2OM(
  SSdir,
  nsim = 48,
  proyears = 50,
  reps = 1,
  maxF = 3,
  seed = 1,
  interval = 1,
  Obs = DLMtool::Generic_Obs,
  Imp = DLMtool::Perfect_Imp,
  import_mov = TRUE,
  gender = 1:2,
  age_rec = 1,
  silent = FALSE,
  Name = "OM generated by SS2OM function",
  Source = "No source provided",
  Author = "No author provided",
  report = FALSE,
  filename = "SS2OM",
  dir = tempdir(),
  open_file = TRUE,
  ...
)

Arguments

SSdir

A folder with Stock Synthesis input and output files in it.

nsim

The number of simulations to take for parameters with uncertainty (for OM@cpars custom parameters).

proyears

The number of projection years for MSE

reps

The number of stochastic replicates within each simulation in the operating model.

maxF

The maximum allowable F in the operating model.

seed

The random seed for the operating model.

interval

The interval at which management procedures will update the management advice in runMSE, e.g., 1 = annual updates.

Obs

The observation model (class Obs). This function only updates the catch and index observation error.

Imp

The implementation model (class Imp). This function does not update implementation parameters.

import_mov

Logical, whether to import movement matrix from the assessment.

gender

An integer that indexes the sex for importing life history parameters (1 = usually female, 2 = usually male, 1:2 = mean across both sexes).

age_rec

Integer for the age of recruitment. The default is 1 for DLMtool operating models. Generally, should not be changed.

silent

Whether to silence messages to the console.

Name

The name of the operating model

Source

Reference to assessment documentation e.g. a url

Author

Who did the assessment

report

Logical, if TRUE, the function will run runMSE to generate historical data from the operating model to compare against SS output. A markdown report will be generated.

filename

If report = TRUE, character string for the name of the markdown and HTML files.

dir

If report = TRUE, the directory in which the markdown and HTML files will be saved.

open_file

If report = TRUE, whether the HTML document is opened after it is rendered.

...

Arguments to pass to SS_output.

Details

The function generally uses values from the terminal year of the assessment for most life history parameters (maturity, M, etc). This function does detect time-varying growth in the assessment and uses annual length/weight-at-age for historical years. Selectivity is derived from the F-at-age matrix.

Value

An object of class OM.

Note

Currently supports versions of r4ss on CRAN (v.1.24) and Github (v.1.34-38).

Author(s)

T. Carruthers and Q. Huynh

See Also

SS2Data


tcarruth/MSEtool documentation built on Oct. 19, 2020, 6:09 a.m.