simList-accessors-metadata: Metadata accessors

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

Metadata accessors

Description

These accessors extract the metadata for a module (if specified) or all modules in a simList if not specified.

Usage

inputObjects(sim, module, path)

## S4 method for signature 'simList'
inputObjects(sim, module, path)

## S4 method for signature 'missing'
inputObjects(sim, module, path)

outputObjects(sim, module, path)

## S4 method for signature 'simList'
outputObjects(sim, module, path)

## S4 method for signature 'missing'
outputObjects(sim, module, path)

outputObjectNames(sim, module)

## S4 method for signature 'simList'
outputObjectNames(sim, module)

reqdPkgs(sim, module, modulePath)

## S4 method for signature 'simList'
reqdPkgs(sim, module, modulePath)

## S4 method for signature 'missing'
reqdPkgs(sim, module, modulePath)

documentation(sim, module)

## S4 method for signature 'simList'
documentation(sim, module)

sessInfo(sim)

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

Arguments

sim	A simList object from which to extract element(s) or in which to replace element(s).
module	Character vector of module name(s)
path	The path to the module., i.e., the modulePath. Only relevant if sim not supplied.
modulePath	That path where module can be found. If set already using setPaths, it will use that. This will be ignored if sim is supplied and is required if sim not supplied

Examples

# set modulePath
setPaths(modulePath = getSampleModules(tempdir()))
# use Require and reqdPkgs
pkgs <- reqdPkgs(module = c("caribouMovement", "randomLandscapes", "fireSpread"))

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