SpaDES (version 1.3.1)

paths: Specify paths for modules, inputs, and outputs

Description

Accessor functions for the paths slot in a simList object.

Usage

paths(object)
# S4 method for .simList
paths(object)
paths(object) <- value
# S4 method for .simList
paths(object) <- value
cachePath(object)
# S4 method for .simList
cachePath(object)
cachePath(object) <- value
# S4 method for .simList
cachePath(object) <- value
inputPath(object)
# S4 method for .simList
inputPath(object)
inputPath(object) <- value
# S4 method for .simList
inputPath(object) <- value
outputPath(object)
# S4 method for .simList
outputPath(object)
outputPath(object) <- value
# S4 method for .simList
outputPath(object) <- value
modulePath(object)
# S4 method for .simList
modulePath(object)
modulePath(object) <- value
# S4 method for .simList
modulePath(object) <- value

Arguments

object

A simList simulation object.

value

The object to be stored at the slot.

Value

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

Details

These are ways to add or access the file paths used by spades. There are four file paths: cachePath, modulePath, inputPath, and outputPath. Each has a function to get or set the value in a simList object. If no paths are specified, the defaults are as follows:

• cachePath: getOption("spades.cachePath");

• inputPath: getOption("spades.modulePath");

• modulePath: getOption("spades.inputPath");

• inputPath: getOption("spades.outputPath").

See Also

SpaDES, specifically the section 1.2.4 on Simulation Paths.

Other functions to access elements of a simList object: .addDepends, doEvent.checkpoint, envir, events, globals, inputs, ls.simList, ls.str.simList, modules, objs, packages, params, progressInterval, times