Save a SpaDES simulation to an RDS file

Saves a simList to an RDS file via SpaDES.core::saveSimList(). Heavy ancillary data (inputs, outputs, cache, files) are excluded so the file contains only the simulation state; pair with outTar() to bundle the output files separately.

outSave(sim, runName, simFilename = NULL, lazy = TRUE)

Arguments

sim

A simList object.

runName

Character scalar. Used as the base name for the saved sim file and tarball.

simFilename

Character scalar. Full path for the .rds file. Defaults to SpaDES.core::simFile(name = runName, path = outputPath(sim), time = end(sim), ext = "rds").

lazy

Logical. Passed to SpaDES.core::saveSimList(). When TRUE (default), each user object in sim@.xData is saved into a sibling <simFilename>_xData/ directory and lazily restored on load via delayedAssign. outTar() picks up that directory automatically.

Value

Invisibly returns simFilename.

See also

outTar(), outUpload(), outSaveTarUpload()