Skip to content

camelCase functions that are not S3 generics #336

@gustavdelius

Description

@gustavdelius

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions