Learn R Programming

⚠️There's a newer version (2.5.3) of this package.Take me there.

Mizer is an R package to run dynamic multi-species size-spectrum models of fish communities. The package has been developed to model marine ecosystems that are subject to fishing. However, it may also be appropriate for other ecosystems.

The package contains routines and functions to allow users to set up an ecosystem model, and then project it through time under different fishing strategies. Methods are included to explore the results, including plots and calculation of community indicators such as the slope of the size spectrum. Size-based models can be complicated so mizer contains many default options that can be easily changed by the user.

Mizer has been supporting research in marine ecology and fisheries science since 2014 (see publications). Mizer is still under active development. Version 2.0 has increased the user-friendliness and the flexibility of the framework. Contributions from the user community are very welcome. There is a sister package called mizerExperimental where user contributions can be checked out and receive feedback from the community. Example mizer models can be contributed to mizerExamples.

Does your project or publication use mizer? If so, we would love to know. You can also join our Google Discussion group here: https://groups.google.com/forum/#!forum/size-spectrum-models

Recent work on mizer was funded by the European Commission Horizon 2020 Research and Innovation Programme under Grant Agreement No 634495 for the project MINOUW (http://minouw-project.eu/) and the Australian Research Council Discovery Project Rewiring Marine Food Webs.

Installation

The package is on CRAN and therefore available from R’s built-in package manager.

# Install release version from CRAN
install.packages("mizer")

# Alternatively, install development version from GitHub
devtools::install_github("sizespectrum/mizer")

Example

The following code loads the mizer package, loads some information about species in the North Sea that comes as an example with the package, sets up the parameters for the mizer model, and runs a simulation for 10 years.

library(mizer)
params <- newMultispeciesParams(NS_species_params, inter)
sim <- project(params, t_max = 10, effort = 0)

The results of the simulation can then be analysed, for example via plots:

plot(sim)

See the accompanying Get started page for more details on how the package works, including detailed examples.

Dynamic multi-species size-spectrum models

A mizer model captures the interactions between multiple species. The growth rates of fish are determined by the availability of prey and the death rates are influenced by the abundance of predators, as well as fishing. The model starts with the individual-level physiological rates for each species, as well as the predation preferences, and deduces the population-level dynamics from these. Thus quantities like fish diets and fisheries yields emerge dynamically and can be projected into the future.

Because a mizer model tracks the size of individuals as they grow up over several orders of magnitude from their egg size to their maximum size, it correctly tracks the ontogenetic diet shifts. An individual typically moves through several trophic levels during its life time. This is often not correctly captured in other multi-species models.

A mizer model can be set up with only a small amount of information because it uses allometric scaling relations and size-based feeding rules to choose sensible defaults for unknown parameters.

Setting up a new multi-species mizer model is a two-step process, similar to what may be familiar from Ecopath with Ecosim: First one calibrates the model to describe a steady state that is in agreement with current observations (as in Ecopath), then one chooses the additional parameters that determine the dynamics away from the steady state (as in Ecosim). This model can then be used to investigate future effects of changes in fishing policy or of environmental stressors.

Modelling environmental change

A mizer model is a good tool for studying the effect of environmental changes, like climate change, because it is a mechanistic model that can deduce the complex population-level changes that one is interested in from the simpler changes in the physiological rates and feeding interactions of individual fish species.

Smooth traffic on the biomass highway

It is interesting to think of the marine ecosystem as a transport system that moves biomass from the size of primary producers (mostly unicellular plankton) up to the sizes of fish that humans like to consume. Each fish that grows up from egg size to maturity by eating smaller individuals is like a car on this biomass highway. The yield of our fisheries depend on this traffic flowing smoothly and without traffic jams.

An analogy with road traffic may be helpful:

In road traffic, if traffic density gets too high in a section of the highway, drivers slow down, which leads to a pile-up producing even higher traffic density, leading to further slow-down in a potentially vicious cycle known as a traffic jam. Traffic management that ignores how the traffic density affects traffic speed fails. Luckily our mathematical understanding of transport equations has made practical contributions to managing traffic in ways that produce smoother traffic flow and hence higher throughput.

Mizer implements the transport equations for marine ecosystems. The potential for traffic jams is the same: if for example there is a high density of predators of a particular size, which all have preference for prey of a particular smaller size, then due to competition for that prey the growth of those predators slows down, leading to a pile-up which leads to further depletion of prey, leading to further slow-down, in a potentially vicious cycle.

Luckily the natural ecosystem has evolved to facilitate very smooth traffic on the biomass highway with resultant high productivity. This state is characterised by an approximate power-law shape of the biomass size spectrum. The purpose of mizer is to allow us to understand how various stressors, like fishing or climate change, affect the size spectrum and hence flow of biomass and the productivity and resilience of the marine ecosystem. Mizer allows us to investigate how size-based fisheries management strategies can be used to keep the ecosystem close to its natural productive state.

A model one can understand

One big advantage of a mizer model is that it is based on a strong mathematical foundation. This allows a degree of a priori understanding of the behaviour of the model that is absent in many other multi-species model. This theoretical foundation is well presented in the book “Fish Ecology, Evolution, and Exploitation” by Ken Andersen.

Copy Link

Version

Install

install.packages('mizer')

Monthly Downloads

300

Version

2.2.1

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Gustav Delius

Last Published

August 3rd, 2021

Functions in mizer (2.2.1)

MizerParams

Alias for set_multispecies_model()
MizerSim

Constructor for the MizerSim class
NS_sim

Example MizerSim object for the North Sea example
N

Time series of size spectra
MizerParams-class

A class to hold the parameters for a size based model.
NOther

Time series of other components
NS_species_params

Example species parameter set based on the North Sea
BevertonHoltRDD

Beverton Holt function to calculate density-dependent reproduction rate
MizerSim-class

A class to hold the results of a simulation
NS_params

Example MizerParams object for the North Sea example
compareParams

Compare two MizerParams objects and print out differences
constantEggRDI

Choose egg production to keep egg density constant
SheperdRDD

Sheperd function to calculate density-dependent reproduction rate
addSpecies

Add new species
emptyParams

Create empty MizerParams object of the right size
finalN

Size spectra at end of simulation
default_pred_kernel_params

Set defaults for predation kernel parameters
getEGrowth

Get energy rate available for growth
customFunction

Replace a mizer function with a custom version
getDiet

Get diet of predator at size, resolved by prey species
NS_species_params_gears

Example species parameter set based on the North Sea with different gears
animateSpectra

Animation of the abundance spectra
box_pred_kernel

Box predation kernel
RickerRDD

Ricker function to calculate density-dependent reproduction rate
constantRDD

Give constant reproduction rate
constant_other

Helper function to keep other components constant
getESpawning

Alias for getERepro()
double_sigmoid_length

Length based double-sigmoid selectivity function
getBiomass

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

Measure distance between current and previous state in terms of fish abundances
getCommunitySlope

Calculate the slope of the community abundance
getPredRate

Get predation rate
getMeanMaxWeight

Calculate the mean maximum weight of the community
getPredMort

Get total predation mortality rate
getM2Background

Alias for getResourceMort()
getERepro

Get energy rate available for reproduction
getEReproAndGrowth

Get energy rate available for reproduction and growth
finalNOther

Values of other ecosystem components at end of simulation
getMeanWeight

Calculate the mean weight of the community
gear_params

Gear parameters
getEffort

Fishing effort used in simulation
getGrowthCurves

Get growth curves giving weight as a function of age
getProportionOfLargeFish

Calculate the proportion of large fish
getFMortGear

Get the fishing mortality by time, gear, species and size
getM2

Alias for getPredMort()
getRDD

Get density dependent reproduction rate
get_time_elements

Get_time_elements
getResourceMort

Get predation mortality rate for resource
get_size_range_array

Get size range array
getReproductionLevel

Get reproduction level
initialNResource<-

Initial value for resource spectrum
getMort

Get total mortality rate
inter

Example interaction matrix for the North Sea example
getZ

Alias for getMort()
get_phi

Get values from feeding kernel function
get_f0_default

Get default value for f0
getRDI

Get density independent rate of egg production
distanceMaxRelRDI

Measure distance between current and previous state in terms of RDI
different

Check whether two objects are different
getFeedingLevel

Get feeding level
getPhiPrey

Get available energy
knife_edge

Weight based knife-edge selectivity function
get_required_reproduction

Determine reproduction rate needed for initial egg abundance
log_breaks

Helper function to produce nice breaks on logarithmic axes
getTimes

Times for which simulation results are available
getSSB

Calculate the SSB of species
initialN<-

Initial values for fish spectra
plotGrowthCurves

Plot growth curves giving weight as a function of age
plotFeedingLevel

Plot the feeding level of species by size
getComponent

Get information about other ecosystem components
getCriticalFeedingLevel

Get critical feeding level
initialNOther<-

Initial values for other ecosystem components
mizerPredRate

Get predation rate needed to project standard mizer model
mizerPredMort

Get total predation mortality rate needed to project standard mizer model
newMultispeciesParams

Set up parameters for a general multispecies model
newSingleSpeciesParams

Set up parameters for a single species in a power-law background
plotYield

Plot the total yield of species through time
plotYieldGear

Plot the total yield of each species by gear through time
setColours

Set line colours to be used in mizer plots
setBevertonHolt

Set Beverton-Holt density dependence
project

Project size spectrum forward in time
projectToSteady

Project to steady state
getRates

Get all rates
getYield

Calculate the yearly yield for each species
getPredKernel

Get predation kernel
getEncounter

Get encounter rate
mizerResourceMort

Get predation mortality rate for resource needed to project standard mizer model
getFMort

Get the total fishing mortality rate from all fishing gears by time, species and size.
getN

Calculate the number of individuals within a size range
getParams

Extract the parameter object underlying a simulation
getYieldGear

Calculate the yearly yield per gear and species
get_initial_n

Calculate initial population abundances for the community populations
setInteraction

Set species interaction matrix
plotPredMort

Plot predation mortality rate of each species against size
resource_constant

Keep resource abundance constant
setFishing

Set fishing parameters
newCommunityParams

Set up parameters for a community-type model
set_multispecies_model

Deprecated obsolete function for setting up multispecies parameters
setInitialValues

Set initial values to final values of a simulation
set_species_param_default

Set a species parameter to a default value
resource_params

Resource parameters
plotSpectra

Plot the abundance spectra
setParams

Set or change any model parameters
setPredKernel

Set predation kernel
setSearchVolume

Set search volume
get_ks_default

Get default value for ks
validParams

Validate MizerParams object and upgrade if necessary
species_params

Species parameters
validGearParams

Check validity of gear parameters and set defaults
sigmoid_weight

Weight based sigmoidal selectivity function
w

Size bins
setRateFunction

Set own rate function to replace mizer rate function
setReproduction

Set reproduction parameters
setLinetypes

Set linetypes to be used in mizer plots
idxFinalT

Time index at end of simulation
set_community_model

Deprecated function for setting up parameters for a community-type model
indicator_functions

Description of indicator functions
validEffortVector

Return valid effort vector
upgradeSim

Upgrade MizerSim object from earlier mizer versions
mizerEGrowth

Get energy rate available for growth needed to project standard mizer model
plotDiet

Plot diet, resolved by prey species, as function of predator at size.
mizerEReproAndGrowth

Get energy rate available for reproduction and growth needed to project standard mizer model
mizerEncounter

Get encounter rate needed to project standard mizer model
mizerRDI

Get density-independent rate of reproduction needed to project standard mizer model
mizerRates

Get all rates needed to project standard mizer model
plotFMort

Plot total fishing mortality of each species by size
resource_semichemostat

Project resource using semichemostat model
get_gamma_default

Get default value for gamma
get_h_default

Get default value for h
mizerERepro

Get energy rate available for reproduction needed to project standard mizer model
mizerFMort

Get the total fishing mortality rate from all fishing gears
plotM2

Alias for plotPredMort()
noRDD

Give density-independent reproduction rate
mizerFMortGear

Get the fishing mortality needed to project standard mizer model
newTraitParams

Set up parameters for a trait-based multispecies model
mizer-package

mizer: Multi-species size-based modelling in R
renameSpecies

Rename species
plot,MizerSim,missing-method

Summary plot for MizerSim objects
lognormal_pred_kernel

Lognormal predation kernel
removeSpecies

Remove species
mizerFeedingLevel

Get feeding level needed to project standard mizer model
retune_erepro

Retune reproduction efficiency to maintain initial egg abundances
setExtMort

Set external mortality rate
setComponent

Add a dynamical ecosystem component
mizerMort

Get total mortality rate needed to project standard mizer model
set_trait_model

Deprecated function for setting up parameters for a trait-based model
plotDataFrame

Make a plot from a data frame
plotBiomass

Plot the biomass of species through time
plotting_functions

Description of the plotting functions
sigmoid_length

Length based sigmoid selectivity function
truncated_lognormal_pred_kernel

Truncated lognormal predation kernel
upgradeParams

Upgrade MizerParams object from earlier mizer versions
power_law_pred_kernel

Power-law predation kernel
project_simple

Project abundances by a given number of time steps into the future
reexports

Objects exported from other packages
setMaxIntakeRate

Set maximum intake rate
setMetabolicRate

Set metabolic rate
steady

Set initial values to a steady state for the model
summary,MizerSim-method

Summarize MizerSim object
setResource

Set up resource
setRmax

Alias for setBevertonHolt()
summary_functions

Description of summary functions
summary,MizerParams-method

Summarize MizerParams object
valid_species_arg

Helper function to assure validity of species argument
validSpeciesParams

Validate species parameter data frame