ArrayTimeBySpecies: S3 class for time x species arrays

In mizer: Dynamic Multi-Species Size Spectrum Modelling

S3 class for time x species arrays

Description

Some functions in mizer return two-dimensional arrays (time x species) holding quantities like biomass, abundance, or yield rate through time. The ArrayTimeBySpecies class wraps these arrays to provide convenient print(), summary(), plot(), and as.data.frame() methods.

Usage

ArrayTimeBySpecies(
  x,
  value_name = NULL,
  units = NULL,
  type = NULL,
  params = NULL
)

is.ArrayTimeBySpecies(x)

Arguments

x	A matrix (time x species). For is.ArrayTimeBySpecies(), any object to test.
value_name	A string giving the human-readable name for the value.
units	A string giving the units (e.g. "g", "g/year").
type	The kind of quantity the values are, see ArraySpeciesBySize() and array_types.
params	A MizerParams object holding the model that created the values.

Details

An ArrayTimeBySpecies object behaves just like a regular matrix for arithmetic operations and subsetting. It carries these lightweight attributes:

• value_name – a human-readable name for the value (e.g. "Biomass").

• units – the units of the value (e.g. "g", "g/year").

• params – the MizerParams object that created the values.

Value

An ArrayTimeBySpecies object (inherits from matrix and array).

is.ArrayTimeBySpecies() returns TRUE if x is an ArrayTimeBySpecies object, FALSE otherwise.

See Also

print(), summary(), as.data.frame(), plot()

Examples

bio <- getBiomass(NS_sim)
is.ArrayTimeBySpecies(bio)
summary(bio)

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