simList and ancillary filesLoading a simList from file can be problematic as there are non-standard
objects that must be rebuilt. See description in saveSimList() for details.
unzipSimList is a convenience wrapper around unzip and loadSimList where
all the files are correctly identified and passed to
loadSimList(..., otherFiles = xxx). See zipSimList for details.
loadSimList(
filename,
projectPath = getwd(),
tempPath = tempdir(),
paths = NULL,
otherFiles = "",
verbose = getOption("reproducible.verbose")
)unzipSimList(zipfile, load = TRUE, paths = getPaths(), ...)
For loadSimList(), a simList object.
For unzipSimList(), either a character vector of file names unzipped
(if load = FALSE), or a simList object.
Character giving the name of a saved simulation file.
Currently, only file types .qs or .rds are supported.
An optional path for the project within which the simList
exists. This is used to identify relative paths for saving and loading the simList.
A character string specifying the new base directory for the
temporary paths maintained in a simList.
A list of character vectors for all the simList paths. When
loading a simList, this will replace the paths of everything to
these new paths. Experimental still.
A character vector of (absolute) file names locating each of the
existing file-backed Raster* files that are the real paths for the possibly
incorrect paths in Filenames(sim) if the the file being read in is from
a different computer, path, or drive. This could be the output from unzipSimList
(which is calls loadSimList internally, passing the unzipped filenames)
Numeric, -1 silent (where possible), 0 being very quiet,
1 showing more messaging, 2 being more messaging, etc.
Default is 1. Above 3 will output much more information about the internals of
Caching, which may help diagnose Caching challenges. Can set globally with an
option, e.g., options('reproducible.verbose' = 0) to reduce to minimal
Filename of a zipped simList
Logical. If TRUE, the default, then the simList will
also be loaded into R.
passed to unzip
If cache is used, it is likely that it should be trimmed before
zipping, to include only cache elements that are relevant.
saveSimList(), zipSimList()