Learn R Programming

SpaDES.core (version 0.2.7)

doEvent.checkpoint: 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

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

checkpointLoad(file, envir = parent.frame())

.checkpointSave(sim, file)

checkpointFile(sim)

# S4 method for simList checkpointFile(sim)

checkpointFile(sim) <- value

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

checkpointInterval(sim)

# S4 method for simList checkpointInterval(sim)

checkpointInterval(sim) <- value

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

Arguments

sim

A simList simulation object.

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.

envir

the environment where the data should be loaded.

value

The object to be stored at the slot.

Value

Returns the modified simList object.

Details

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

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()