simList-accessors-modules: Simulation modules and dependencies

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

Simulation modules and dependencies

Description

Accessor functions for the depends and modules slots in a simList object. These are included for advanced users.

depends()	List of simulation module dependencies. (advanced)
modules()	List of simulation modules to be loaded. (advanced)
inputs()	List of loaded objects used in simulation. (advanced)

Usage

modules(sim, hidden = FALSE)

## S4 method for signature 'simList'
modules(sim, hidden = FALSE)

modules(sim) <- value

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

depends(sim)

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

depends(sim) <- value

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

Arguments

sim	A simList object from which to extract element(s) or in which to replace element(s).
hidden	Logical. If TRUE, show the default core modules.
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.7 on Modules and dependencies.

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

PredictiveEcology/SpaDES.core documentation built on April 17, 2024, 8:27 a.m.