Save objects using .saveObjects in params slot of simInit

In the simInit() call, a parameter called .saveObjects can be provided in each module. This must be a character string vector of all object names to save. These objects will then be saved whenever a call to saveFiles is made.

saveFiles(sim)

Arguments

sim

A simList simulation object.

Value

(invisibly) the modified sim object. invoked for side effect of saving the simulation to file.

Details

The file names will be equal to the object name plus time(sim) is appended at the end. The files are saved as .rds files, meaning, only one object gets saved per file.

For objects saved using this function, the module developer must create save events that schedule a call to saveFiles.

If this function is used outside of a module, it will save all files in the outputs(sim) that are scheduled to be saved at the current time in the simList.

There are several ways to save objects using SpaDES.

Note

It is not possible to schedule separate saving events for each object that is listed in the .saveObjects.

Model-level saving

Using the outputs slot in the simInit() call. See example in simInit(). This can be convenient because it gives overall control of many modules at a time, and it gets automatically scheduled during the simInit() call.

Module-level saving

Using the saveFiles function inside a module. This must be accompanied by a .saveObjects vector or list element in the params slot in the simList(). Usually a module developer will create this method for future users of their module.

Custom saving

A module developer can save any object at any time inside their module, using standard R functions for saving R objects (e.g., save or saveRDS). This is the least modular approach, as it will happen whether a module user wants it or not.

Author

Eliot McIntire and Alex Chubaty

Examples

# \donttest{
if (requireNamespace("SpaDES.tools", quietly = TRUE) &&
    requireNamespace("NLMR", quietly = TRUE)) {
## This will save the "caribou" object at the save interval of 1 unit of time
## in the outputPath location
  outputPath <- file.path(tempdir(), "test_save")
  times <- list(start = 0, end = 1, "month")

  modules <- list("randomLandscapes", "caribouMovement")
  paths <- list(
    modulePath = getSampleModules(tempdir()),
    outputPath = outputPath
  )
 opts <- options("spades.moduleCodeChecks" = FALSE,
                 "spades.useRequire" = FALSE) # not necessary for example

  ## save multiple outputs
  parameters <- list(
    .globals = list(stackName = "landscape"),
    caribouMovement = list(
      .saveObjects = c("caribou", "habitatQuality"),
      .saveInitialTime = 1, .saveInterval = 1
    ),
    randomLandscapes = list(.plots = NA, nx = 20, ny = 20))

  mySim <- simInit(times = times, params = parameters, modules = modules,
                 paths = paths)

  spades(mySim, .plotInitialTime = NA) # plotting not relevant for this example
  dir(outputPath)
  # remove the files
  file.remove(dir(outputPath, full.names = TRUE))

  options(opts) # clean up

}# }
#> Setting:
#>   options(
#>     spades.outputPath = '/tmp/RtmpXxjf07/test_save'
#>     spades.modulePath = '/tmp/RtmpXxjf07/sampleModules'
#>   )
#> Paths set to:
#>   options(
#>     rasterTmpDir = '/tmp/RtmpXxjf07/SpaDES/scratch/raster'
#>     reproducible.cachePath = '/tmp/RtmpXxjf07/myProject/cache'
#>     spades.inputPath = '/tmp/RtmpXxjf07/myProject/inputs'
#>     spades.outputPath = '/tmp/RtmpXxjf07/test_save'
#>     spades.modulePath = '/tmp/RtmpXxjf07/sampleModules'
#>     spades.scratchPath = '/tmp/RtmpXxjf07/SpaDES/scratch'
#>   )
#>   terra::terraOptions(tempdir = '/tmp/RtmpXxjf07/SpaDES/scratch/terra'
#> Sep18 15:24:20 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> Sep18 15:24:20 simInit The following .globals were used:
#> Sep18 15:24:20 simInit Key: <global, module>
#> Sep18 15:24:20 simInit               module    global
#> Sep18 15:24:20 simInit               <char>    <char>
#> Sep18 15:24:20 simInit  1:  caribouMovement stackName
#> Sep18 15:24:20 simInit  2: randomLandscapes stackName
#> Elapsed time for simInit: 0.08173919 secs
#> Sep18 15:24:20 simInit Using setDTthreads(1). To change: 'options(spades.DTthreads = X)'.
#> Sep18 15:24:20 chckpn:init total elpsd: 0.084 secs | 0 checkpoint init 0
#> Sep18 15:24:20 save  :init total elpsd: 0.086 secs | 0 save init 0
#> Sep18 15:24:20 prgrss:init total elpsd: 0.088 secs | 0 progress init 0
#> Sep18 15:24:20 load  :init total elpsd: 0.09 secs | 0 load init 0
#> Sep18 15:24:20 rndmLn:init total elpsd: 0.093 secs | 0 randomLandscapes init 
#> Sep18 15:24:20 rndmLn:init New objects created:
#> Sep18 15:24:20 rndmLn:init <char>
#> Sep18 15:24:20 rndmLn:init  1:  landscape
#> Sep18 15:24:20 crbMvm:init total elpsd: 0.5 secs | 0 caribouMovement init 1
#> Sep18 15:24:20 crbMvm:init New objects created:
#> Sep18 15:24:20 crbMvm:init <char>
#> Sep18 15:24:20 crbMvm:init  1:    caribou
#> Sep18 15:24:20 crbMvm:move total elpsd: 0.51 secs | 1 caribouMovement move 5
#> Sep18 15:24:20 crbMvm:move New objects created:
#> Sep18 15:24:20 crbMvm:move <char>
#> Sep18 15:24:20 crbMvm:move  1: habitatQuality
#> Sep18 15:24:20 crbMvm:save total elpsd: 0.58 secs | 1 caribouMovement save 11
#> Sep18 15:24:22 crbMvm:save caribouMovement
#> simList saved in
#> SpaDES.core:::savedSimEnv()$.sim
#> It will be deleted at next spades() call.