Function reference • roleR

All functions

buildFun(): buildFun

cFun(): C fun wrapper

checkRolePhylo(): check RolePhylo checker function for validation

createRolePredModel(): createRolePredModel

dataFunCpp: dataFunCpp

hillAbund() hillGenetic() hillTrait() hillPhylo() richness(): Hill number summary statistics for `roleData` objects.

.bufferModelData(): buffer model data

.hillDivSAD(): HillDivSAD function for abundance-based

.hillDivTrait(): HillDivTrait function for trait-based

.lseriesFromSN(): Logseries from S and N

getFinalState(): Get the final state of a model run.

getSumStats(): Get summary statistics for RoLE objects.

getSumStatsMean(): Get SumStats mean

getValuesFromParams(): Get vals from params

intFunCpp: intFunCpp

iterModelCpp: iterModelCpp

localComm(): The local community of a `roleData`

metaComm(): The metacommunity of a `roleData`

paramValues-class paramValues: paramValues clas

quickExp(): quickExp

quickModel(): quickModel

quickModelNonRun(): quickModelNonRun

quickParams(): Internal functions to facilitate vignette examples.

rawAbundance() rawSppID() rawTraits() rawGenDiv() rawSeqs() rawBranchLengths() rawApePhylo(): Get raw data from `roleData` objects.

rawSpAbundance(): abundance

repS4(): Repeat an S4 object

roleData(): A collection of data representing one state of a roleModel.

roleDataFromCpp(): roleDataFromCpp

roleDataToCpp(): roleDataToCpp

roleExperiment(): roleExperiment - one or more models bundled collectively

roleModel(): A single RoLE model.

roleModelGiven(): roleModelGiven

roleParams(): Parameters of one roleModel

rolePhylo(): A phylogeny of all the species in a `roleData` object.

runRole(): Run a `roleModel` or `roleExperiment`.

setContext(): Set context metadata to an experiment

`[`(<roleExperiment>,<numeric>,<numeric>,<logical>): [

testRand(): testRand

untbParams(): Wrapper around roleParams to create a "untb-flavored" (Unified Neutral Theory of Biodiversity) roleModel

vectFunCpp(): vectFunCpp

writeRole(): Write a roleExperiment to disk