roleModel-class: A single RoLE model.

In role-model/roleR: Rules of Life Engine

A single RoLE model.

Description

An S4 class that holds one RoLE model realization. A model is first initialized using a set of parameters, then run using those parameters.

Details

See the 'roleR_intro' vignette for an example modeling workflow.

Slots

modelSteps

A list of 'roleData' objects, one for each saved snapshot. For example, the 3rd saved snapshot is accessed at 'modelSteps[[3]]'. Models that are not yet run only have one timestep, i.e. 'modelSteps[[1]]'

params

A 'roleParams' object containing the params of the model

info

a 'data.frame' with one row for each saved snapshot (unrun models will only have 1 row); columns are parameters, cells are parameter values at each snapshot

Examples

# Create a model using a default set of params, then run it.
m <- roleModel(roleParams())
m <- runRole(m)

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