Constructors for objects of MizerParams class
Constructor method for the
class. Provides the simplest way of making a
MizerParams object to be used in a simulation.
A data frame of species specific parameter values (see notes below).
Optional argument to specify the
interaction matrix of the species (predator by prey). If
missing a default interaction is used where all
interactions between species are set to 1. Note that any
dimnames of the interaction matrix argument are ignored
by the constructor. The dimnames of the interaction
matrix in the returned
Additional arguments used to specify the dimensions and sizes of the model. These include:
An object of type
The only essential argument to the
constructor is a data frame which contains the species
data. The data frame is arranged species by parameter, so
each column of the parameter data frame is a parameter
and each row has the parameters for one of the species in
There are some essential columns that must be included in
the parameter data.frame and that do not have default
values. Other columns do have default values, so that if
they are not included in the species parameter data
frame, they will be automatically added when the
MizerParams object is created. See the
accompanying vignette for details of these columns.
An additional constructor method which takes an integer
of the number of species in the model. This is only used
in internally to set up a
MizerParams object with
the correct dimensions. It is not recommended that this
method is used by users.
1 2 3