sim_species_rate: Build a 'MizerSim' rate getter that resolves the rate...

In mizer: Dynamic Multi-Species Size Spectrum Modelling

Build a MizerSim rate getter that resolves the rate functions once

Description

Like sim_size_rate() but for getters that return one value per species at each time step (a time-by-species array), such as getRDI() and getRDD(). By default these use the initial effort, matching their MizerParams counterparts.

Usage

sim_species_rate(
  sim,
  time_range,
  target,
  slot,
  value_name,
  units = NULL,
  use_sim_effort = FALSE,
  ...
)

Arguments

sim	A MizerSim object.
time_range	Passed to the sim iteration helper.
target	Name of the rate to calculate (as in params@rates_funcs).
slot	Name of the element to extract from the mizer_rates_subset() result (e.g. "e_growth" for the EGrowth rate).
value_name, units	Metadata for the returned array.
use_sim_effort	If TRUE, the saved effort at each time step is used; otherwise the initial effort is used (matching the behaviour of the corresponding MizerParams getter).
...	Passed on to the rate functions.

Value

An ArrayTimeBySpecies object.

mizer documentation built on Aug. 24, 2026, 9:08 a.m.