projection: Projections for assessment models

Description Usage Arguments Examples

View source: R/define_S4_class_project.R

Description

This function takes an assessment model and runs a stochastic projection based on future F or catch.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
projection(
  Assessment,
  constrain = c("F", "Catch"),
  FMort = NULL,
  Catch = NULL,
  p_years = 50,
  p_sim = 200,
  obs_error = NULL,
  process_error = NULL,
  max_F = 3,
  seed = 499
)

Arguments

Assessment

An object of class Assessment.

constrain

Whether to project on future F or catch. By default, projects on F.

FMort

The projection F, either of length 1 for constant F for the entirety of the projection or length p_years.

Catch

The projection catch, either of length 1 for constant catch for the entirety of the projection or length p_years.

p_years

Integer for the number of projection years.

p_sim

Integer for the number of simulations for the projection.

obs_error

Vector of length two for standard deviation of error to be added to the index and catch, respectively. If NULL, uses values from assessment model.

process_error

Numeric, standard deviation for process error (e.g., recruitment or biomass deviates). If NULL, uses values from assessment model.

max_F

The maximum allowable F if the projection is constrained on catch.

seed

An integer to set the seed for the sampling observation and process error deviates.

Examples

1
2
myAssess <- SCA(Data = SimulatedData)
do_projection <- projection(myAssess, FMort = myAssess@FMSY)

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