Skip to contents

[Superseded]

Each of these functions is an alias for a function with a shorter name that returns exactly the same thing. The shorter name is the one that also has a replacement function (catchability(params) <- value and friends), so that is the name to use:

SupersededUse instead
getCatchability()catchability()
getSelectivity()selectivity()
getInitialEffort()initial_effort()
getInteraction()interaction_matrix()
getResourceDynamics()resource_dynamics()
getResourceLevel()resource_level()
getResourceRate()resource_rate()
getResourceCapacity()resource_capacity()
getPredKernel()pred_kernel()
getSearchVolume()search_vol()
getMaxIntakeRate()intake_max()
getMetabolicRate()metab()
getExtMort()ext_mort()
getExtEncounter()ext_encounter()
getMaturityProportion()maturity()
getReproductionProportion()repro_prop()
getReproductionLevel()reproduction_level()

The get prefix is reserved for the functions that calculate a rate from the current state of a model, like getEncounter() or getFMort(). The functions above only read back a value that is already stored in the MizerParams object, which is what the bare names say.

The old names are however not going away. They are plain aliases: they do not warn and they will keep working, so existing code and old scripts run unchanged. They are not used anywhere inside mizer and should not be used in new code.

Usage

getCatchability(params)

getSelectivity(params)

getInitialEffort(params)

getInteraction(params)

getResourceDynamics(params)

getResourceLevel(params)

getResourceRate(params)

getResourceCapacity(params)

getPredKernel(params)

getSearchVolume(params)

getMaxIntakeRate(params)

getMetabolicRate(params)

getExtMort(params)

getExtEncounter(params)

getMaturityProportion(params)

getReproductionProportion(params)

getReproductionLevel(params)

Arguments

params

A MizerParams object

Value

The same as the function it is an alias for.