mizer (version 3.0.0)

summary: Summarise mizer objects

Description

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

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.

...

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.

See Also

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

Examples

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