Skip to contents

Calculate the total biomass of each species within a size range at each time step.

Source: R/summary_methods.R
getBiomass.Rd

Calculates the total biomass through time within user defined size limits. The default option is to use the whole size range. You can specify minimum and maximum weight or length range for the species. Lengths take precedence over weights (i.e. if both min_l and min_w are supplied, only min_l will be used).

Usage

getBiomass(object, ...)

Arguments

object

An object of class MizerParams or MizerSim.

...

Arguments passed on to get_size_range_array

min_w

Smallest weight in size range. Defaults to smallest weight in the model.

max_w

Largest weight in size range. Defaults to largest weight in the model.

min_l

Smallest length in size range. If supplied, this takes precedence over min_w.

max_l

Largest length in size range. If supplied, this takes precedence over max_w.

Value

If called with a MizerParams object, a vector with the biomass in grams for each species in the model. If called with a MizerSim object, an array (time x species) containing the biomass in grams at each time step for all species.

See also

Other summary functions: getDiet(), getGrowthCurves(), getN(), getSSB(), getYield(), getYieldGear()

Examples

biomass <- getBiomass(NS_sim)
biomass["1972", "Herring"]
#> [1] 218218354800
biomass <- getBiomass(NS_sim, min_w = 10, max_w = 1000)
biomass["1972", "Herring"]
#> [1] 154290431041