model_actions: Generate a standard set of model actions

View source: R/setup-utils.R

model_actionsR Documentation

Generate a standard set of model actions

Description

Generate a standard set of model actions

Usage

model_actions(
  imm,
  mat,
  mlgg = 15,
  mature = TRUE,
  comp_id = "species",
  rec_id = list(imm, mat),
  rec_scalar_id = list(imm, mat),
  init_mode = 1,
  parametric_sd = FALSE,
  exp_params = c(),
  tv_params = c(),
  by_age_params = c(),
  recruiting = !mature
)

Arguments

imm

A g3 stock object for immature specimens

mat

A g3 stock object for mature specimens

mlgg

maxlengthgroupgrowth for growth of both mature/immature

mature

Generate actions for mature (TRUE) or immature (FALSE) stock

comp_id

Part of stock name to use for parameters, e.g. 'species' will share parameters with both mature/immature

rec_id

Part of stock name to use for recruitment parameters, e.g. 'species' will share parameters with both mature/immature

rec_scalar_id

Part of stock name to use for recruitment scalar parameter, e.g. 'species' will share parameters with both mature/immature

init_mode

One of 0 (initialised at equilibrium), 1 (Initial parameter per age group (across stocks)), 2 (Initial parameter per age group per stock)

parametric_sd

Is the initial conditions stddev parameterised, or a table by age?

exp_params

Which parameters should be exponentiated? exp_params is a vector of parameter names, possible parameters include: c('linf','k','bbin','recl','rec.sd','mat_alpha','mat_l50','init','init.scalar','rec','rec.scalar','init.f','m','walpha','wbeta'). Note that is a scalar is exponentiated the annual values will be too, and vice versa.

tv_params

Which parameters should be time-varying? tv_params is a vector of parameter names, possible time-varying parameters include: 'linf','k','walpha','beta','bbin','recl','rec.sd','mat_alpha','mat_l50','m'

by_age_params

Which parameters should be age-varying? by_age_params is a vector of parameter names, possible time-varying parameters include: 'linf','k','walpha','beta','bbin','mat_alpha','mat_l50','m'

recruiting

If TRUE, the renewal action will be added. Defaults to !mature, so it can be used to create a single non-maturing stock.

Value

A list of g3 actions


gadget-framework/gadgetutils documentation built on Nov. 11, 2024, 6:25 p.m.