simList-accessors-envir: Simulation environment

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Simulation environment

Description

Accessor functions for the .xData slot, which is the default virtual slot for an S4 class object that inherits from an S3 object (specifically, the simList inherits from environment) in a simList object. These are included for advanced users.

Usage

envir(sim)

## S4 method for signature 'simList'
envir(sim)

envir(sim) <- value

## S4 replacement method for signature 'simList'
envir(sim) <- value

Arguments

sim	A simList object from which to extract element(s) or in which to replace element(s).
value	The object to be stored at the slot.

Details

Currently, only get and set methods are defined. Subset methods are not.

Value

Returns or sets the value of the slot from the simList object.

Author(s)

Alex Chubaty

See Also

SpaDES.core-package, specifically the section 1.2.8 on simList environment.

Other functions to access elements of a 'simList' object: .addDepends(), checkpointFile(), events(), globals(), inputs(), modules(), objs(), packages(), params(), paths(), progressInterval(), times()

SpaDES.core documentation built on June 22, 2024, 10:32 a.m.