SpaDES (version 1.0.1)

params: Get and set simulation parameters.

Description

Accessor functions for the params slot of a simList object and its elements. Additonal methods are provided to access core module and global parameters: Commonly used ll{ globals List of global simulation parameters. params Nested list of all simulation parameter. } Advanced use lll{ Accessor method Module Description checkpointFile .checkpoint Name of the checkpoint file. (advanced) checkpointInterval .checkpoint The simulation checkpoint interval. (advanced) modulePath NA Global simulation module path. (advanced) outputPath NA Global simulation output path. (advanced) inputPath NA Global simulation input path. (advanced) paths NA Global simulation paths (modules, inputs, outputs). (advanced) inputs inputs data.frame identifying objects to load, files etc. & arguments (optional). (advanced) outputs outputs data.frame identifying objects to save, files etc. & arguments (optional). (advanced) progressType .progress Type of graphical progress bar used. (advanced) progressInterval .progress Interval for the progress bar. (advanced) }

Usage

params(object)

## S3 method for class 'simList':
params(object)

params(object) <- value

## S3 method for class 'simList':
params(object) <- value

checkpointFile(object)

## S3 method for class 'simList':
checkpointFile(object)

checkpointFile(object) <- value

## S3 method for class 'simList':
checkpointFile(object) <- value

checkpointInterval(object)

## S3 method for class 'simList':
checkpointInterval(object)

checkpointInterval(object) <- value

## S3 method for class 'simList':
checkpointInterval(object) <- value

progressType(object)

## S3 method for class 'simList':
progressType(object)

progressType(object) <- value

## S3 method for class 'simList':
progressType(object) <- value

progressInterval(object)

## S3 method for class 'simList':
progressInterval(object)

progressInterval(object) <- value

## S3 method for class 'simList':
progressInterval(object) <- value

globals(object)

## S3 method for class 'simList':
globals(object)

globals(object) <- value

## S3 method for class 'simList':
globals(object) <- value

outputPath(object)

## S3 method for class 'simList':
outputPath(object)

outputPath(object) <- value

## S3 method for class 'simList':
outputPath(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

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

See Also

simList-class, simList-accessors-modules, simList-accessors-events, simList-accessors-times.