init_abund: Generate parameterised g3a_initial_abund

View source: R/setup-utils.R

init_abundR Documentation

Generate parameterised g3a_initial_abund

Description

Generate parameterised g3a_initial_abund

Usage

init_abund(
  imm,
  mat,
  comp_id = "species",
  mature = TRUE,
  init_mode = 1,
  exp_init = FALSE,
  exp_init_scalar = FALSE,
  exp_init_f = FALSE,
  naturalmortality = gadget3::g3_parameterized("M", by_stock = TRUE)
)

Arguments

imm

A g3 stock object for immature specimens

mat

A g3 stock object for mature specimens

comp_id

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

mature

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

init_mode

One of: 0 (A single scalar that decays with mortality), 1 (Initial parameter per age group (across stocks)), 2 (Initial parameter per age group per stock), 3 (Initialised at equilibrium, special case for cetaceans, see https://gadget-framework.github.io/gadget-course/marine-mammals.html)

exp_init

Logical, whether the initial age-specific parameters should be exponentiated

exp_init_scalar

Logical, whether the initial scalar should be exponentiated

exp_init_f

Logical, whether the parameter 'init.f' should be exponentiated

naturalmortality

A g3 parameter for natural mortality

Value

g3a_initial_abund formula for use in g3a_initialconditions_normalparam()


gadget-framework/gadgetutils documentation built on Aug. 16, 2024, 8:45 a.m.