loadFile

internal

A collection of high-level, machine- and OS-independent tools
for making 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 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

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 

loadFile function

<dl><dt>file</dt>
<dd><code>character(1)</code> specifying the path to the file to load.</dd>
<dt>cacheId</dt>
<dd><code>character(1)</code> the unique cache identifier of the object.</dd>
<dt>cachePath</dt>
<dd><code>character(1)</code> path to the cache directory.</dd>
<dt>drv</dt>
<dd>A DBI driver object (e.g., <code>RSQLite::SQLite()</code>). Used when
the cache format needs to be swapped.</dd>
<dt>conn</dt>
<dd>A DBI connection object. If <code>NULL</code>, a new connection is
created internally as needed.</dd>
<dt>verbose</dt>
<dd><code>integer</code> or <code>logical</code>. If <code>&gt; 0</code> or <code>TRUE</code>, print
informational messages. Defaults to <code>getOption("reproducible.verbose")</code>.</dd>
<dt>...</dt>
<dd>Allows <code>format</code> for backward compatibility.</dd></dl>

Arguments

Load a file from the cache — loadFile

<dl>

<dt>file</dt>
<dd><code>character(1)</code> specifying the path to the file to load.</dd>


<dt>cacheId</dt>
<dd><code>character(1)</code> the unique cache identifier of the object.</dd>


<dt>cachePath</dt>
<dd><code>character(1)</code> path to the cache directory.</dd>


<dt>drv</dt>
<dd>A DBI driver object (e.g., <code>RSQLite::SQLite()</code>). Used when
the cache format needs to be swapped.</dd>


<dt>conn</dt>
<dd>A DBI connection object. If <code>NULL</code>, a new connection is
created internally as needed.</dd>


<dt>verbose</dt>
<dd><code>integer</code> or <code>logical</code>. If <code>&gt; 0</code> or <code>TRUE</code>, print
informational messages. Defaults to <code>getOption("reproducible.verbose")</code>.</dd>


<dt>...</dt>
<dd>Allows <code>format</code> for backward compatibility.</dd>

</dl>

Load a file from the cache

loadFile: Load a file from the cache

Description

Usage

Value

Arguments