CacheDigest

This can be used by a user to pre-test their arguments before running
<code>Cache</code>, for example to determine whether there is a cached copy.

A collection of high-level, machine- and OS-independent tools
for making deeply reproducible and reusable content in R.
The two workhorse functions are 'Cache()' and 'prepInputs()'. `Cache()`
allows for nested caching, is robust to environments and objects with
environments (like functions), and has deals with some classes of
file-backed R objects e.g., from `terra` and `raster` packages.
Both functions have been developed to
be foundational components of data retrieval
and processing in continuous workflow situations. In both functions,
efforts are made to make the first and subsequent calls of functions have
the same result, but faster at subsequent times by way of checksums
and digesting. Several features are still under development, including
cloud storage of cached objects, allowing for sharing between users. Several
advanced options are available, see '?reproducibleOptions()'.

Eliot J B

reproducible

A Set of Tools that Enhance Reproducibility of R Code

Eliot J B McIntire

Alex M Chubaty

Tati Micheletti

Ceres Barros

Ian Eddy

His Majesty the King in Right of Canada, as represented by the Minister of Natural Resources Canada 

CacheDigest function

<dl><dt>objsToDigest</dt>
<dd>A list of all the objects (e.g., arguments) to be digested</dd>
<dt>...</dt>
<dd>passed to <code>.robustDigest</code>.</dd>
<dt>algo</dt>
<dd>The algorithms to be used; currently available choices are
 <code>md5</code>, which is also the default, <code>sha1</code>, <code>crc32</code>,
 <code>sha256</code>, <code>sha512</code>, <code>xxhash32</code>, <code>xxhash64</code>,
 <code>murmur32</code>, <code>spookyhash</code> and <code>blake3</code>.</dd>
<dt>calledFrom</dt>
<dd>a Character string, length 1, with the function to
compare with. Default is "Cache". All other values may not produce
robust CacheDigest results.</dd>
<dt>quick</dt>
<dd>Logical or character. If <code>TRUE</code>,
no disk-based information will be assessed, i.e., only
memory content. See Details section about <code>quick</code> in <code>Cache()</code>.</dd></dl>

Arguments

The exact digest function that Cache uses — CacheDigest

<dl>

<dt>objsToDigest</dt>
<dd>A list of all the objects (e.g., arguments) to be digested</dd>


<dt>...</dt>
<dd>passed to <code>.robustDigest</code>.</dd>


<dt>algo</dt>
<dd>The algorithms to be used; currently available choices are
 <code>md5</code>, which is also the default, <code>sha1</code>, <code>crc32</code>,
 <code>sha256</code>, <code>sha512</code>, <code>xxhash32</code>, <code>xxhash64</code>,
 <code>murmur32</code>, <code>spookyhash</code> and <code>blake3</code>.</dd>


<dt>calledFrom</dt>
<dd>a Character string, length 1, with the function to
compare with. Default is "Cache". All other values may not produce
robust CacheDigest results.</dd>


<dt>quick</dt>
<dd>Logical or character. If <code>TRUE</code>,
no disk-based information will be assessed, i.e., only
memory content. See Details section about <code>quick</code> in <code>Cache()</code>.</dd>

</dl>

CacheDigest: The exact digest function that `Cache` uses

Description

Usage

Value

Arguments

Examples