runRole: Run a 'roleModel' or 'roleExperiment'

In role-model/roleR: Rules of Life Engine

Run a 'roleModel' or 'roleExperiment'

Description

'runRole' takes a 'role*' object and simulates all processes specified in the given parameters

Usage

runRole(x, cores = 1)

## S4 method for signature 'roleModel'
runRole(x)

## S4 method for signature 'roleExperiment'
runRole(x, cores = 1)

Arguments

x	'roleModel' or 'roleExperiment' object to run
cores	number of cores

Details

Prior to invoking 'runRole', the 'role*' input object must be initialized with a set of parameters, e.g., as generated by 'roleParams'.

Value

'roleModel' or 'roleExperiment' run for the specified number of time steps

Examples

# create and run a model
model <- roleModel(roleParams())
model <- runRole(model)

# create and run an experiment
p1 <- roleParams(dispersal_prob = 0.2)
p2 <- roleParams(dispersal_prob = 0.3)
p3 <- roleParams(dispersal_prob = 0.4)
exp <- roleExperiment(list(p1,p2,p3))
exp <- runRole(exp)

role-model/roleR documentation built on April 3, 2025, 1:06 p.m.