The package convention is camelCase for method names. The following functions are camelCase but are not S3 generics (i.e. they do not dispatch via UseMethod). This is an inventory to help review whether any of these should be converted to S3 generics or otherwise renamed for consistency.
Constructor / factory
newCommunityParams, newMultispeciesParams, newSingleSpeciesParams, newTraitParams
emptyParams
Default rate implementations (mizer*)
mizerDiffusion, mizerEGrowth, mizerEncounter, mizerERepro, mizerEReproAndGrowth
mizerFeedingLevel, mizerFMort, mizerFMortGear, mizerMort
mizerPredMort, mizerPredRate, mizerRates, mizerRDI, mizerResourceMort
Getters (not generic)
getComponent, getESpawning, getM2, getM2Background, getPhiPrey
getRateFunction, getResourceCapacity, getResourceDynamics, getResourceLevel, getResourceRate, getZ
finalNOther, initialNOther
Setters (not generic)
setComponent, setRateFunction, setRmax
Plotters
plotDataFrame, plotM2
plotlyBiomass, plotlyBiomassObservedVsModel, plotlyFeedingLevel, plotlyFMort
plotlyGrowthCurves, plotlyPredMort, plotlySpectra, plotlyYield, plotlyYieldGear, plotlyYieldObservedVsModel
Validation
validColours, validEffortArray, validEffortVector, validGearParams
validGivenSpeciesParams, validLinetypes, validMizerParams, validSpeciesParams
Other
compareSpeciesParams, completeSpeciesParams, constantEggRDI, constantRDD
customFunction, markBackground, noRDD, readParams
removeBackgroundSpecies, removeComponent, summariseArrayDiff
truncateSim, upgradeParams, upgradeSim
The package convention is camelCase for method names. The following functions are camelCase but are not S3 generics (i.e. they do not dispatch via
UseMethod). This is an inventory to help review whether any of these should be converted to S3 generics or otherwise renamed for consistency.Constructor / factory
newCommunityParams,newMultispeciesParams,newSingleSpeciesParams,newTraitParamsemptyParamsDefault rate implementations (
mizer*)mizerDiffusion,mizerEGrowth,mizerEncounter,mizerERepro,mizerEReproAndGrowthmizerFeedingLevel,mizerFMort,mizerFMortGear,mizerMortmizerPredMort,mizerPredRate,mizerRates,mizerRDI,mizerResourceMortGetters (not generic)
getComponent,getESpawning,getM2,getM2Background,getPhiPreygetRateFunction,getResourceCapacity,getResourceDynamics,getResourceLevel,getResourceRate,getZfinalNOther,initialNOtherSetters (not generic)
setComponent,setRateFunction,setRmaxPlotters
plotDataFrame,plotM2plotlyBiomass,plotlyBiomassObservedVsModel,plotlyFeedingLevel,plotlyFMortplotlyGrowthCurves,plotlyPredMort,plotlySpectra,plotlyYield,plotlyYieldGear,plotlyYieldObservedVsModelValidation
validColours,validEffortArray,validEffortVector,validGearParamsvalidGivenSpeciesParams,validLinetypes,validMizerParams,validSpeciesParamsOther
compareSpeciesParams,completeSpeciesParams,constantEggRDI,constantRDDcustomFunction,markBackground,noRDD,readParamsremoveBackgroundSpecies,removeComponent,summariseArrayDifftruncateSim,upgradeParams,upgradeSim