downloadFile

Optional character string giving the path of an archive
containing <code>targetFile</code>, or a vector giving a set of nested archives
(e.g., <code>c("xxx.tar", "inner.zip", "inner.rar")</code>). If there is/are (an) inner
archive(s), but they are unknown, the function will try all until it finds
the <code>targetFile</code>. See table in <code><a rd-options="" href="/link/preProcess?package=reproducible&version=1.1.1" data-mini-rdoc="reproducible::preProcess">preProcess</a></code>.

targetFile

Character string giving the name of the file(s) to be extracted.

neededFiles

Character string of a directory in which to download
and save the file that comes from <code>url</code> and is also where the function
will look for <code>archive</code> or <code>targetFile</code>. NOTE (still experimental):
To prevent repeated downloads in different locations, the user can also set
<code>options("reproducible.inputPaths")</code> to one or more local file paths to
search for the file before attempting to download. Default for that option is
<code>NULL</code> meaning do not search locally.

destinationPath

Logical. This is passed internally to <code><a rd-options="" href="/link/Checksums?package=reproducible&version=1.1.1" data-mini-rdoc="reproducible::Checksums">Checksums</a></code>
(the quickCheck argument), and to
<code><a rd-options="" href="/link/Cache?package=reproducible&version=1.1.1" data-mini-rdoc="reproducible::Cache">Cache</a></code> (the quick argument). This results in faster, though
less robust checking of inputs. See the respective functions.

quick

A character string indicating the absolute path to the <code>CHECKSUMS.txt</code>
file.

checksumFile

Optional "download function" name, such as <code>"raster::getData"</code>, which does
custom downloading, in addition to loading into R. Still experimental.

dlFun

A checksums file, e.g., created by Checksums(..., write = TRUE)

checkSums

Optional character string indicating the URL to download from.
If not specified, then no download will be attempted. If not entry
exists in the <code>CHECKSUMS.txt</code> (in <code>destinationPath</code>), an entry
will be created or appended to. This <code>CHECKSUMS.txt</code> entry will be used
in subsequent calls to
<code>prepInputs</code> or <code>preProcess</code>, comparing the file on hand with the ad hoc
<code>CHECKSUMS.txt</code>. See table in <code><a rd-options="" href="/link/preProcess?package=reproducible&version=1.1.1" data-mini-rdoc="reproducible::preProcess">preProcess</a></code>.

A numeric, with <code>0</code> indicating do not write a new checksums,
<code>1</code> write a new one,
<code>2</code> append new information to existing one.

needChecksums

Logical. Should downloading and all the other actions occur
even if they pass the checksums or the files are all there.

overwrite

Logical or Integer. <code>0/FALSE</code> (default) keeps existing
<code>CHECKSUMS.txt</code> file and
<code>prepInputs</code> will write or append to it. <code>1/TRUE</code> will deleted the entire
<code>CHECKSUMS.txt</code> file. Other options, see details.

purge

Optional temporary path for internal file intermediate steps.
Will be cleared on.exit from this function.

.tempPath

Passed to <code>dlFun</code>. Still experimental.

Currently, this only deals with <code><a rd-options="googledrive" href="/link/drive_download?package=reproducible&version=1.1.1&to=googledrive" data-mini-rdoc="googledrive::drive_download">drive_download</a></code>,
and <code><a rd-options="utils" href="/link/download.file?package=reproducible&version=1.1.1&to=utils" data-mini-rdoc="utils::download.file">download.file</a></code>.

Collection of high-level, robust, machine- and OS-independent tools
for making deeply reproducible and reusable content in R.
The three workhorse functions are Cache, prepInputs, and Require;
these allow for nested caching, robust to environments, and objects with
environments (like functions), and data retrieval and processing, and
package handling 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.

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 

downloadFile function

Optional character string giving the path of an archive
containing <code>targetFile</code>, or a vector giving a set of nested archives
(e.g., <code>c("xxx.tar", "inner.zip", "inner.rar")</code>). If there is/are (an) inner
archive(s), but they are unknown, the function will try all until it finds
the <code>targetFile</code>. See table in <code><a rd-options='' href='preProcess'>preProcess</a></code>.

Character string giving the path to the eventual file
(raster, shapefile, csv, etc.) after downloading and extracting from a zip
or tar archive. This is the file before it is passed to
<code>postProcess</code>. Currently, the internal checksumming does not checksum
the file after it is <code>postProcess</code>ed (e.g., cropped/reprojected/masked).
Using <code>Cache</code> around <code>prepInputs</code> will do a sufficient job in these cases.
See table in <code><a rd-options='' href='preProcess'>preProcess</a></code>.

Logical. This is passed internally to <code><a rd-options='' href='Checksums'>Checksums</a></code>
(the quickCheck argument), and to
<code><a rd-options='' href='Cache'>Cache</a></code> (the quick argument). This results in faster, though
less robust checking of inputs. See the respective functions.

Optional character string indicating the URL to download from.
If not specified, then no download will be attempted. If not entry
exists in the <code>CHECKSUMS.txt</code> (in <code>destinationPath</code>), an entry
will be created or appended to. This <code>CHECKSUMS.txt</code> entry will be used
in subsequent calls to
<code>prepInputs</code> or <code>preProcess</code>, comparing the file on hand with the ad hoc
<code>CHECKSUMS.txt</code>. See table in <code><a rd-options='' href='preProcess'>preProcess</a></code>.

Currently, this only deals with <code><a rd-options='googledrive' href='drive_download'>drive_download</a></code>,
and <code><a rd-options='utils' href='download.file'>download.file</a></code>.

downloadFile: A wrapper around a set of downloading functions

Description

Usage

Arguments