# A Set of Tools that Enhance Reproducibility Beyond Package Management

## Documentation for package ‘reproducible’ version 0.2.8

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A B C D E F G I K L M N P R S U W misc

reproducible-package | The 'reproducible' package

## -- A --

asPath | Coerce a character string to a class "Path"
asPath.character | Coerce a character string to a class "Path"
assessDataType | Assess the appropriate raster layer data type
assessDataType.default | Assess the appropriate raster layer data type
assessDataType.Raster | Assess the appropriate raster layer data type
assessDataType.RasterStack | Assess the appropriate raster layer data type
assessDataTypeGDAL | Assess the appropriate raster layer data type for GDAL

## -- B --

basename2 | A version of 'base::basename' that is 'NULL' resistant

## -- C --

Cache | Cache method that accommodates environments, S4 methods, Rasters, & nested caching
Cache-method | Cache method that accommodates environments, S4 methods, Rasters, & nested caching
CacheDigest | The exact digest function that 'Cache' uses
cc | Examining and modifying the cache
checkGDALVersion | Check whether the system has a minimum version of GDAL available
checkoutVersion | Clone, fetch, and checkout from GitHub.com repositories
checkPath | Check directory path
checkPath-method | Check directory path
Checksums | Calculate checksum
Checksums-method | Calculate checksum
clearCache | Examining and modifying the cache
clearCache-method | Examining and modifying the cache
clearStubArtifacts | Clear erroneous archivist artifacts
clearStubArtifacts-method | Clear erroneous archivist artifacts
cloudCache | Experimental use of googledrive for Caching
cloudCheck | Basic tool for using cloud-based caching
cloudDownloadChecksums | Cloud extras
cloudExtras | Cloud extras
cloudSyncCache | Sync cloud with local Cache
cloudUpdateChecksums | Cloud extras
cloudWrite | Basic tool for using cloud-based caching
compareNA | 'NA'-aware comparison of two vectors
convertPaths | Change the absolute path of a file
convertRasterPaths | Change the absolute path of a file
Copy | Recursive copying of nested environments, and other "hard to copy" objects
Copy-method | Recursive copying of nested environments, and other "hard to copy" objects
copyFile | Copy a file using 'robocopy' on Windows and 'rsync' on Linux/macOS
copySingleFile | Copy a file using 'robocopy' on Windows and 'rsync' on Linux/macOS
cropInputs | Crop a 'Spatial*' or 'Raster*' object
cropInputs.default | Crop a 'Spatial*' or 'Raster*' object
cropInputs.sf | Crop a 'Spatial*' or 'Raster*' object
cropInputs.spatialObjects | Crop a 'Spatial*' or 'Raster*' object

## -- D --

determineFilename | Determine filename, either automatically or manually
downloadFile | A wrapper around a set of downloading functions

## -- E --

extractFromArchive | Extract files from archive

## -- F --

fastMask | Faster operations on rasters

## -- G --

getArtifact | Cache helpers
getCacheId | Cache helpers
getGDALVersion | Check the GDAL version in use
getUserTags | Cache helpers

## -- I --

installedVersions | Determine versions all installed packages
installVersions | Install exact package versions from a package version text file & GitHub

## -- K --

keepCache | Examining and modifying the cache
keepCache-method | Examining and modifying the cache

## -- L --

linkOrCopy | Hardlink, symlink, or copy a file

## -- M --

makeMemoisable | Generic method to make or unmake objects memoisable
makeMemoisable.default | Generic method to make or unmake objects memoisable
maskInputs | Mask module inputs
maskInputs.Raster | Mask module inputs
maskInputs.sf | Mask module inputs
maskInputs.Spatial | Mask module inputs
mergeCache | Merge two cache repositories together
mergeCache-method | Merge two cache repositories together

## -- N --

newLibPaths | A shortcut to create a '.libPaths()' with only two directories
normPath | Normalize filepath
normPath-method | Normalize filepath

## -- P --

package_dependenciesMem | Memoised version of package_dependencies
Path-class | Coerce a character string to a class "Path"
pipe | A cache-aware pipe that does not mask with '%>%'
pkgDep | Determine package dependencies, first looking at local filesystem
pkgDep2 | Determine package dependencies, first looking at local filesystem
pkgSnapshot | Take a snapshot of all the packages and version numbers
postProcess | Generic function to post process objects
postProcess.default | Generic function to post process objects
postProcess.list | Generic function to post process objects
postProcess.sf | Generic function to post process objects
postProcess.spatialObjects | Generic function to post process objects
prepInputs | Download and optionally post process files
preProcess | Download, Checksum, Extract files
projectInputs | Project 'Raster*' or Spatial* or 'sf' objects
projectInputs.default | Project 'Raster*' or Spatial* or 'sf' objects
projectInputs.Raster | Project 'Raster*' or Spatial* or 'sf' objects
projectInputs.sf | Project 'Raster*' or Spatial* or 'sf' objects
projectInputs.Spatial | Project 'Raster*' or Spatial* or 'sf' objects

## -- R --

readLinesRcpp | Alternative to readLines that is faster
readLinesRcppInternal | Alternative to readLines that is faster
reproducible | The 'reproducible' package
reproducibleOptions | 'reproducible' options
Require | Repeatability-safe install and load packages, optionally with specific versions

## -- S --

searchFull | Search up the full scope for functions
searchFullEx | Search up the full scope for functions
showCache | Examining and modifying the cache
showCache-method | Examining and modifying the cache
suffix | Add a prefix or suffix to the basename part of a file path

## -- U --

unmakeMemoisable | Generic method to make or unmake objects memoisable
unmakeMemoisable.default | Generic method to make or unmake objects memoisable
unrarPath | The known path for unrar or 7z

## -- W --

writeFuture | Write to archivist repository, using 'future::future'
writeOutputs | Write module inputs on disk
writeOutputs.default | Write module inputs on disk
writeOutputs.Raster | Write module inputs on disk
writeOutputs.sf | Write module inputs on disk
writeOutputs.Spatial | Write module inputs on disk

## -- misc --

%<% | Cache method that accommodates environments, S4 methods, Rasters, & nested caching
%C% | A cache-aware pipe that does not mask with '%>%'
.addChangedAttr | Add an attribute to an object indicating which named elements change
.addChangedAttr-method | Add an attribute to an object indicating which named elements change
.addTagsToOutput | Add tags to object
.addTagsToOutput-method | Add tags to object
.cacheMessage | Create a custom cache message by class
.cacheMessage-method | Create a custom cache message by class
.checkCacheRepo | Check for cache repository info in ...
.checkCacheRepo-method | Check for cache repository info in ...
.debugCache | Attach debug info to return for Cache
.installPackages | Internal function to install packages
.objSizeInclEnviros | Determine object size of all objects inside environments
.objSizeInclEnviros-method | Determine object size of all objects inside environments
.orderDotsUnderscoreFirst | Sort or order any named object with dotted names and underscores first
.preDigestByClass | Any miscellaneous things to do before '.robustDigest' and after 'FUN' call
.preDigestByClass-method | Any miscellaneous things to do before '.robustDigest' and after 'FUN' call
.prefix | Add a prefix or suffix to the basename part of a file path
.prepareFileBackedRaster | Copy the file-backing of a file-backed Raster* object
.prepareOutput | Make any modifications to object recovered from cacheRepo
.prepareOutput-method | Make any modifications to object recovered from cacheRepo
.setSubAttrInList | Set subattributes within a list by reference
.sortDotsUnderscoreFirst | Sort or order any named object with dotted names and underscores first
.suffix | Add a prefix or suffix to the basename part of a file path
.tagsByClass | Add extra tags to an archive based on class
.tagsByClass-method | Add extra tags to an archive based on class
.unrarPath | The known path for unrar or 7z