Learn R Programming

mizer (version 3.0.0)

sim_species_rate: 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(). These use the initial effort, matching their MizerParams counterparts.

Usage

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

Value

An ArrayTimeBySpecies object.

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.

...

Passed on to the rate functions.