getFinalState: Get the final state of a model run.

getFinalStateR Documentation

Get the final state of a model run.

Description

Gets the final state of a model from either a 'roleExperiment' or a 'roleModel'.

Usage

getFinalState(x, modID, ...)

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

## S4 method for signature 'roleExperiment'
getFinalState(x, modID)

Arguments

x

The 'roleExperiment' or 'roleModel' object to retrieve the final state from.

modID

Optional argument to retrieve the final state for specific model(s) in a 'roleExperiment' object; can be a vector of unique IDs.

...

passed

Details

If 'modID' is not supplied and 'x' is a 'roleExperiment', then a list of 'roleData' objects for each model run is returned.


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