checkpoint: Simulation checkpoints

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

Simulation checkpoints

Description

Save and reload the current state of the simulation, including the state of the random number generator, by scheduling checkpoint events.

Usage

checkpointFile(sim)

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

checkpointFile(sim) <- value

## S4 replacement method for signature 'simList'
checkpointFile(sim) <- value

checkpointInterval(sim)

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

checkpointInterval(sim) <- value

## S4 replacement method for signature 'simList'
checkpointInterval(sim) <- value

doEvent.checkpoint(sim, eventTime, eventType, debug = FALSE)

checkpointLoad(file)

.checkpointSave(sim, file)

Arguments

sim	A simList simulation object.
value	The parameter value to be set (in the corresponding module and param).
eventTime	A numeric specifying the time of the next event.
eventType	A character string specifying the type of event: one of either "init", "load", or "save".
debug	Optional logical flag determines whether sim debug info will be printed (default debug = FALSE).
file	The checkpoint file.

Value

Returns the modified simList object.

Note

Checkpoint files are intended to be used locally, and do not invoke the simulation archiving tools to bundle and subsequently extract simulation files (e.g., file-backed rasters).

RNG save code adapted from: http://www.cookbook-r.com/Numbers/Saving_the_state_of_the_random_number_generator/ and https://stackoverflow.com/q/13997444/1380598

Author(s)

Alex Chubaty

See Also

.Random.seed.

Other functions to access elements of a 'simList' object: .addDepends(), envir(), events(), globals(), inputs(), modules(), objs(), packages(), params(), paths(), progressInterval(), times()

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