.cacheMessage

.cacheMessage,ANY-method

This is a generic definition that can be extended according to class.

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;
these allow for: nested caching, robust to environments, and objects with
environments (like functions); and data retrieval and processing
in continuous workflow environments. In all cases,
efforts are made to make the first and subsequent calls of functions have
the same result, but vastly faster at subsequent times by way of checksums
and digesting. Several features are still under active 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 Beyond Package
Management

Eliot J B McIntire

Alex M Chubaty

Tati Micheletti

Ceres Barros

Ian Eddy

Her Majesty the Queen in Right of Canada, as represented by the Minister of Natural Resources Canada 

.cacheMessage function

<dl><dt>object</dt>
<dd>Any R object.</dd>
<dt>functionName</dt>
<dd>A character string indicating the function name</dd>
<dt>fromMemoise</dt>
<dd>Logical. If <code>TRUE</code>, the message will be about
recovery from memoised copy</dd>
<dt>verbose</dt>
<dd>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., <code>options('reproducible.verbose' = 0) to reduce to minimal</code></dd></dl>

Arguments

Author

Create a custom cache message by class — .cacheMessage

<dl>

<dt>object</dt>
<dd>Any R object.</dd>


<dt>functionName</dt>
<dd>A character string indicating the function name</dd>


<dt>fromMemoise</dt>
<dd>Logical. If <code>TRUE</code>, the message will be about
recovery from memoised copy</dd>


<dt>verbose</dt>
<dd>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., <code>options('reproducible.verbose' = 0) to reduce to minimal</code></dd>

</dl>

Create a custom cache message by class

.cacheMessage: Create a custom cache message by class

Description

Usage

Value

Arguments

Author

Examples