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.
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.
Examples
# \donttest{
summary(NS_params)
#> An object of class "MizerParams"
#> mizer version: 2.5.4.9126
#> Created: 2021-09-03 20:29:38
#> Modified: 2026-05-09 08:16:12
#> Consumer size spectrum:
#> minimum size: 0.001
#> maximum size: 39851.3
#> no. size bins: 100
#> Resource size spectrum:
#> minimum size: 2.12182e-13
#> maximum size: 9.82091
#> no. size bins: 179 (226 size bins in total)
#> Species details:
#> species w_max w_mat w_min f0 beta sigma
#> 1 Sprat 33.0 13 0.001 0.6 51076 0.8
#> 2 Sandeel 36.0 4 0.001 0.6 398849 1.9
#> 3 N.pout 100.0 23 0.001 0.6 22 1.5
#> 4 Herring 334.0 99 0.001 0.6 280540 3.2
#> 5 Dab 324.0 21 0.001 0.6 191 1.9
#> 6 Whiting 1192.0 75 0.001 0.6 22 1.5
#> 7 Sole 866.0 78 0.001 0.6 381 1.9
#> 8 Gurnard 668.0 39 0.001 0.6 283 1.8
#> 9 Plaice 2976.0 105 0.001 0.6 113 1.6
#> 10 Haddock 4316.5 165 0.001 0.6 558 2.1
#> 11 Cod 39851.3 1606 0.001 0.6 66 1.3
#> 12 Saithe 39658.6 1076 0.001 0.6 40 1.1
#>
#> Fishing gear details:
#> Gear Effort Target species
#> ----------------------------------
#> Industrial 0.00 Sprat, Sandeel, N.pout
#> Pelagic 1.00 Herring
#> Beam 0.50 Dab, Sole, Plaice
#> Otter 0.50 Whiting, Gurnard, Haddock, Cod, Saithe
summary(NS_sim)
#> An object of class "MizerSim"
#> Parameters:
#> An object of class "MizerParams"
#> mizer version: 2.5.4.9126
#> Created: 2021-09-03 20:30:02
#> Modified: 2026-05-09 08:15:13
#> Consumer size spectrum:
#> minimum size: 0.001
#> maximum size: 39851.3
#> no. size bins: 100
#> Resource size spectrum:
#> minimum size: 8.72744e-13
#> maximum size: 9.82091
#> no. size bins: 171 (218 size bins in total)
#> Species details:
#> species w_max w_mat w_min beta sigma
#> 1 Sprat 33.0 13 0.001 51076 0.8
#> 2 Sandeel 36.0 4 0.001 398849 1.9
#> 3 N.pout 100.0 23 0.001 22 1.5
#> 4 Herring 334.0 99 0.001 280540 3.2
#> 5 Dab 324.0 21 0.001 191 1.9
#> 6 Whiting 1192.0 75 0.001 22 1.5
#> 7 Sole 866.0 78 0.001 381 1.9
#> 8 Gurnard 668.0 39 0.001 283 1.8
#> 9 Plaice 2976.0 105 0.001 113 1.6
#> 10 Haddock 4316.5 165 0.001 558 2.1
#> 11 Cod 39851.3 1606 0.001 66 1.3
#> 12 Saithe 39658.6 1076 0.001 40 1.1
#>
#> Fishing gear details:
#> Gear Effort Target species
#> ----------------------------------
#> Sprat 0.00 Sprat
#> Sandeel 0.00 Sandeel
#> N.pout 0.00 N.pout
#> Herring 1.81 Herring
#> Dab 0.76 Dab
#> Whiting 0.63 Whiting
#> Sole 0.91 Sole
#> Gurnard 0.00 Gurnard
#> Plaice 0.76 Plaice
#> Haddock 0.56 Haddock
#> Cod 0.68 Cod
#> Saithe 0.53 Saithe
#> Simulation parameters:
#> Time period: 1967 to 2010
#> Output stored every 1 years
summary(getEncounter(NS_params))
#> Encounter rate [g/year]
#> 12 species x 100 sizes
#>
#> Species Min Mean Max
#> Sprat 0.2992076 2929.178 39573.31
#> Sandeel 0.4528175 3768.983 45507.81
#> N.pout 0.5019776 16840.828 147886.62
#> Herring 0.5752333 6241.503 80375.40
#> Dab 0.4916095 24004.843 266704.99
#> Whiting 0.4362525 17348.364 137539.48
#> Sole 0.3646753 12087.308 148784.12
#> Gurnard 0.3122260 11327.057 135351.68
#> Plaice 0.2323659 11800.440 113242.16
#> Haddock 0.5964130 24932.923 334719.58
#> Cod 0.9658343 52646.610 436916.91
#> Saithe 0.7709631 16377.321 187775.81
summary(getFMort(NS_sim))
#> Fishing mortality [1/year]
#> 44 times x 12 species x 100 sizes
#>
#> Species Min Mean Max
#> Sprat 0.0000000000 0.33743869 2.1827924
#> Sandeel 0.0000000000 0.26816487 1.3102141
#> N.pout 0.0000000000 0.30707882 2.1827924
#> Herring 0.0077894362 0.32918211 1.9100547
#> Dab 0.0017746971 0.04908083 0.1734253
#> Whiting 0.0126246154 0.33123701 1.3975648
#> Sole 0.0268320133 0.30068824 1.1274436
#> Gurnard 0.0000000000 0.01269037 0.1307616
#> Plaice 0.0089964121 0.24671481 0.8671267
#> Haddock 0.0015854377 0.31410333 1.4275908
#> Cod 0.0494762790 0.37063678 1.0721081
#> Saithe 0.0009633361 0.15709914 1.2032865
# }