mizer (version 3.4.0)

summary: Summarise mizer objects

Description

Mizer provides summary() methods for model objects and for the specialised array classes returned by many mizer functions.

Usage

# S3 method for ArraySpeciesBySize
summary(object, all.sizes = FALSE, ...)
# S3 method for ArrayTimeBySpecies
summary(object, ...)
# S3 method for ArrayTimeBySpeciesBySize
summary(object, all.sizes = FALSE, ...)
# S3 method for MizerSim
summary(object, ...)
# S3 method for MizerParams
summary(object, ...)

Value

For MizerParams() and MizerSim(), the object is returned invisibly. For array objects, a list of class summary.ArraySpeciesBySize, summary.ArrayTimeBySpecies or summary.ArrayTimeBySpeciesBySize.

Arguments

object

The object to summarise.

all.sizes

If FALSE (the default), values outside a species' size range (w_min to w_max) are left out, as in plot(). Only for the classes with a size dimension.

...

Further arguments. They are currently ignored by the mizer methods.

Details

For a MizerParams() object, summary() prints the model metadata, size grids, selected species parameters and fishing gear details. For a MizerSim() object, it first prints the parameter summary and then reports the simulated time period and output interval.

For ArraySpeciesBySize(), ArrayTimeBySpecies() and ArrayTimeBySpeciesBySize() objects, summary() returns a small list with the value name, units, dimensions and a per-species data frame containing minimum, mean and maximum values. Printing that summary object gives the same compact table in a human-readable form.

For the two classes that have a size dimension, those values are taken over each species' own size range, from its w_min to its w_max, which is the range plot() draws. A rate array is defined on the whole size grid, but the values outside a species' range describe an animal that does not exist — the encounter rate a 40 kg Sprat would have — and they are usually the extreme ones, so a summary that included them reported the size grid rather than the species. Pass all.sizes = TRUE for the whole grid.

See Also

print(), as.data.frame(), str(), MizerParams(), MizerSim(), ArraySpeciesBySize(), ArrayTimeBySpecies(), ArrayTimeBySpeciesBySize()

Examples

# \donttest{
summary(NS_params)
summary(NS_sim)
summary(getEncounter(NS_params))
summary(getFMort(NS_sim))
# }