Methods for .wrap and .unwrap — .wrap.simList • SpaDES.core

Methods for .wrap and .unwrap

# S3 method for simList
.wrap(
  obj,
  cachePath,
  drv = getOption("reproducible.drv", NULL),
  conn = getOption("reproducible.conn", NULL),
  verbose = getOption("reproducible.verbose")
)

# S3 method for simList
.unwrap(
  obj,
  cachePath,
  cacheId,
  drv = getOption("reproducible.drv", NULL),
  conn = getOption("reproducible.conn", NULL)
)

Arguments

obj: Any arbitrary R object.
cachePath: A repository used for storing cached objects. This is optional if Cache is used inside a SpaDES module.
drv: an object that inherits from DBIDriver, or an existing DBIConnection object (in order to clone an existing connection).
conn: A DBIConnection object, as returned by dbConnect().
verbose: 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
cacheId: Used strictly for messaging. This should be the cacheId of the object being recovered.

Value

The same object as passed into the function, but dealt with so that it can be saved to disk.