Learn R Programming
SpaDES (version 1.1.1)

inputs: Inputs and outputs

Description

Accessor functions for the inputs and outputs slots in a simList object.

inputArgs and outputArgs are ways to specify any arguments that are needed for file loading and file saving. This is still somewhat experimental.

Usage

inputs(object)
## S3 method for class '.simList':
inputs(object)
inputs(object) <- value
## S3 method for class '.simList':
inputs(object) <- value
outputs(object)
## S3 method for class '.simList':
outputs(object)
outputs(object) <- value
## S3 method for class '.simList':
outputs(object) <- value
inputArgs(object)
## S3 method for class '.simList':
inputArgs(object)
inputArgs(object) <- value
## S3 method for class '.simList':
inputArgs(object) <- value
outputArgs(object)
## S3 method for class '.simList':
outputArgs(object)
outputArgs(object) <- value
## S3 method for class '.simList':
outputArgs(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 functions are one of two mechanisms to add the information about which input files to load in a spades call and the information about which output files to save. The other way is to pass them as arguments to a simInit call.

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

inputs accepts a data.frame, with 6 columns. Currently, only one is required. See the modules vignette for more details (browseVignettes("SpaDES")).

Columns are objectName (required, character), file (character), fun (character), package (character), interval (numeric), and loadTime (numeric).

outputs accepts a data.frame, with 5 columns. Currently, only one is required. See the modules vignette for more details (browseVignettes("SpaDES")).

Columns are: objectName (character, required), file (character), fun (character), package (character), and saveTime (numeric).

See Also

simList-class, simList-accessors-modules, simList-accessors-envir, simList-accessors-events, simList-accessors-objects, simList-accessors-params, simList-accessors-paths, simList-accessors-times.