This is experimental and has not been thoroughly tested. Use with caution.
If there is an error during an event, this function will rewind the simulation to a state
numEvents prior to the event that led to the error. The developer may then modify the
source code of the module that caused the break and resume the simulation.
A simList or a filename that will load a simList, e.g., from
saveState or saveSimList. If not supplied (the default),
this will take the sim from
savedSimEnv()$.sim, i.e., the one that was interrupted
A character string length one naming the module that caused the error and
whose source code was fixed. This module will be re-parsed and placed into the simList
Numeric. Default is Inf (i.e., all available).
The number of events to be rewound.
In the simList, if options('spades.recoveryMode') is set to TRUE or a numeric,
then there will be a list in the simList called .recoverableObjs.
These will be replayed backwards in time to reproduce the initial state of the simList
before the event that is numEvents prior to the first event in events(sim).
Logical. If TRUE, then the call to spades will be made, i.e.,
restarting the simulation. If FALSE, then it will return a new simList
with the module code parsed into the simList
Logical or Numeric, follows reproducible.verbose value by default.
Passed to spades, e.g., debug, .plotInitialTime
The filename to save the sim state.
saveState is a wrapper around restartSpades and saveSimList. You can
pass arguments to the ... that will be passed to saveSimList, such as
modules, inputs, outputs.
A list of elements that would be passed to simInit, such as modules.
An optional file that has a saved simList, e.g., from saveSimList
or saveState.
Logical. If TRUE, then it will force simInitAndSpades to be called
even if there is saved sim available.
A simList as if spades had been called on a simList.
A simList, that has been "executed" until end(sim), if it does not
hit an error.
If options('spades.recoveryMode') is set to TRUE or a numeric (default 1), then
there will be a list in the simList called .recoverableObjs.
These record the elements of simList that have changed over a number of events equal
to the number chosen for options('spades.recoveryMode').
The restartSpades function then uses this list to rewind numEvents backwards from the
first event in events(sim) (likely the one that caused the error).
The random number seed will be reset to the state it was at the start of the earliest event recovered, thereby returning to the exact stochastic simulation trajectory.
The simList will be in the state it was numEvents prior to the event
that led to the error (although some objects, e.g., on disk, may have already been modified).
# \donttest{
# options("spades.recoveryMode" = 1) # now the default
s <- simInit()
#> Setting:
#> options(
#> reproducible.cachePath = '/tmp/Rtmp4BAZIc/myProject/cache'
#> spades.inputPath = '/tmp/Rtmp4BAZIc/myProject/inputs'
#> spades.outputPath = '/tmp/Rtmp4BAZIc/myProject/outputs'
#> spades.modulePath = '/tmp/Rtmp4BAZIc/myProject/modules'
#> spades.scratchPath = '/tmp/Rtmp4BAZIc/SpaDES/scratch'
#> )
#> May20 20:31:50 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> Elapsed time for simInit: 0.02854013 secs
s <- spades(s) # if this is interrupted or fails
#> May20 20:31:50 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> May20 20:31:50 chckpn:init total elpsd: 0.029 secs | 0 checkpoint init 0
#> May20 20:31:50 save :init total elpsd: 0.031 secs | 0 save init 0
#> May20 20:31:50 prgrss:init total elpsd: 0.032 secs | 0 progress init 0
#> May20 20:31:50 load :init total elpsd: 0.033 secs | 0 load init 0
#> simList saved in
#> SpaDES.core:::savedSimEnv()$.sim
#> It will be deleted at next spades() call.
## the following line will not work if the previous line didn't fail:
## don't need to specify `sim` if previous line fails;
## will take from savedSimEnv()$.sim automatically
s <- restartSpades(s)
#> This is experimental and should be used with caution.
#> There no saved state prior to any changes that happened in NA. Would you like to proceed from the last state of the simList anyway? i.e., any changes that had already happened inside the module: NA before the fail will be kept...
#> Would you like to restart anyway? (y or n)
#> May20 20:31:50 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> simList saved in
#> SpaDES.core:::savedSimEnv()$.sim
#> It will be deleted at next spades() call.
# }