search

gustavdelius / mizer

This is my old mizer fork that is not actively used any more but still has lots of material in its many branches.
http://gustavdelius.github.io/mizer/
0 stars 2 forks source link

Rename functions for consistency and expressiveness #89

Closed gustavdelius closed 3 years ago

gustavdelius commented 6 years ago

We will introduce new names for some functions but keep the old names around as aliases. Introducing aliases is very easy in R. For example

#' Alias for getAvailEnergy
#' 
#' #' An alias provided for backward compatibility with mizer version <= 1.0
#' @inherit getAvailEnergy
getPhiPrey <- getAvailEnergy

Here are the aliases I have started to introduce. The name on the right is the new one.

MizerParams <- multispeciesParams
getPhiPrey <- getAvailEnergy
getM2 <- getPredMort
getM2Background <- getPlanktonPredMort
getZ <- getMort
getESpawning<- getERepro  # To be consistent with getEReproAndGrowth

Until our next release we can come up with better names. So all suggestions welcome @richardsouthwell .

richardsouthwell commented 6 years ago

I like it all, except I might call it getPlanktonMort, as I dont think we allow anything but predation-type mortality on the plankton