writeFuture: Write to cache repository, using 'future::future' (defunct)
In reproducible: Enhance Reproducibility of R Code

writeFuture

R Documentation

Write to cache repository, using `future::future` (defunct)

Description

Defunct as of version 3.2.0. The future-based cache writing this supported was never enabled by default – reproducible.futurePlan defaults to FALSE – and has been removed. Cache() writes directly.

Usage

writeFuture(
  written,
  outputToSave,
  cachePath,
  userTags,
  drv = getDrv(getOption("reproducible.drv", NULL)),
  conn = getOption("reproducible.conn", NULL),
  cacheId,
  linkToCacheId = NULL,
  verbose = getOption("reproducible.verbose")
)

Arguments

`written`	Integer. If zero or positive then it needs to be written still. Should be 0 to start.
`outputToSave`	The R object to save to repository
`cachePath`	The file path of the repository
`userTags`	Character string of tags to attach to this `outputToSave` in the `CacheRepo`
`drv`	If using a database backend, `drv` must be an object that inherits from `DBIDriver` (e.g., `RSQLite::SQLite`).
`conn`	an optional `DBIConnection` object, as returned by `dbConnect()`.
`cacheId`	Character string. If passed, this will override the calculated hash of the inputs, and return the result from this `cacheId` in the `cachePath`. Setting this is equivalent to manually saving the output of this function, i.e., the object will be on disk, and will be recovered in subsequent This may help in some particularly finicky situations where `Cache` is not correctly detecting unchanged inputs. This will guarantee the object will be identical each time; this may be useful in operational code.
`linkToCacheId`	Optional. If a `cacheId` is provided here, then a `file.link` will be made to the file with that `cacheId` name in the cache repo. This is used when identical outputs exist in the cache. This will save disk space.
`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⁠`