R/MizerParams-class.R
emptyParams.Rd
Sets up a valid MizerParams object with all the slots initialised and given dimension names, but with some slots left empty. This function is to be used by other functions to set up full parameter objects.
emptyParams( species_params, no_w = 100, min_w = 0.001, max_w = NA, min_w_pp = NA, no_w_pp = NA )
species_params | A data frame of species-specific parameter values. |
---|---|
no_w | The number of size bins in the consumer spectrum. |
min_w | Sets the size of the eggs of all species for which this is not
given in the |
max_w | The largest size of the consumer spectrum. By default this is set to the largest w_inf specified in the species_params data frame. |
min_w_pp | The smallest size of the plankton spectrum. |
no_w_pp | No longer used |
An empty but valid MizerParams object
See newMultispeciesParams
for a function that fills the
slots left empty by this function.
A size grid is created so that
the log-sizes are equally spaced. The spacing is chosen so that there will be
no_w
fish size bins, with the smallest starting at min_w
and the largest
starting at max_w
. For w_full
additional size bins are added below
min_w
, with the same log size. The number of extra bins is such that
min_w_pp
comes to lie within the smallest bin.
The species_params
slot of the returned MizerParams object may differ
slightly from the data frame supplied as argument to this function in the
following ways:
Default values are set for w_min, w_inf, alpha, gear, interaction_p
.
The egg sizes in w_min
are rounded down to lie on a grid point.
Note that the other characteristic sizes of the species, like w_mat
and
w_inf
, are not modified to lie on grid points.