Learn R Programming

reproducible (version 0.2.0)

.purge: Purge individual line items from checksums file

Description

Purge individual line items from checksums file

Usage

.purge(checkSums, purge, targetFile, archive, alsoExtract, url)

Arguments

checkSums

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

purge

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

targetFile

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 postProcess. Currently, the internal checksumming does not checksum the file after it is postProcessed (e.g., cropped/reprojected/masked). Using Cache around prepInputs will do a sufficient job in these cases.

archive

Optional character string giving the path of an archive containing targetFile, or a vector giving a set of nested archives (e.g., c("xxx.tar", "inner.zip")). If there is/are (an) inner archive(s), but they are unknown, the function will try all until it finds the targetFile

url

Optional character string indicating the URL to download from. Normally, if used within a module, this url should be explicitly given as sourceURL for an expectsInput. In that case, it will use the module's checksums file to confirm that the download occurred correctly. If URL is used here, an ad hoc checksums will be created in the destinationPath. This will be used in subsequent calls to prepInputs, comparing the file on hand with the ad hoc CHECKSUMS.txt.