SpaDES (version 1.3.1)

progressInterval: Get and set simulation progress bar details

Description

The progress bar can be set in two ways in SpaDES. First, by setting values in the .progress list element in the params list element passed to simInit. Second, at the spades call itself, which can be simpler. See examples.

Usage

progressInterval(object)
# S4 method for .simList
progressInterval(object)
progressInterval(object) <- value
# S4 method for .simList
progressInterval(object) <- value
progressType(object)
# S4 method for .simList
progressType(object)
progressType(object) <- value
# S4 method for .simList
progressType(object) <- value

Arguments

object

A simList simulation object.

value

The object to be stored at the slot.

Details

Progress Bar: Progress type can be one of "text", "graphical", or "shiny". Progress interval can be a numeric. These both can get set by passing a .progress=list(type="graphical", interval=1) into the simInit call. See examples.

See Also

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, paths, times

Examples

# NOT RUN {
mySim <- simInit(times=list(start=0.0, end=100.0),
                 params=list(.globals=list(stackName="landscape"),
                             .progress=list(type="text", interval=10),
                             .checkpoint = list(interval = 10, file = "chkpnt.RData")),
                 modules=list("randomLandscapes"),
                 paths=list(modulePath=system.file("sampleModules", package="SpaDES")))

# progress bar
progressType(mySim) # "text"
progressInterval(mySim) # 10

# parameters
params(mySim) # returns all parameters in all modules
              # including .global, .progress, .checkpoint
globals(mySim) # returns only global parameters

# checkpoint
checkpointFile(mySim) # returns the name of the checkpoint file
                      # In this example, "chkpnt.RData"
checkpointInterval(mySim) # 10
# }