All functions

CacheDigest()

The exact digest function that Cache uses

CacheDBFile() CacheStorageDir() CacheStoredFile() CacheDBTableName() CacheIsACache()

A collection of low level tools for Cache

Checksums()

Calculate checksum

Copy()

Recursive copying of nested environments, and other "hard to copy" objects

cloudCache()

Deprecated

Filenames()

Return the filename(s) from a Raster* object

asPath()

Coerce a character string to a class "Path"

Require()

Repeatability-safe install and load packages, optionally with specific versions

.addChangedAttr()

Add an attribute to an object indicating which named elements change

.addTagsToOutput()

Add tags to object

assessDataType()

Assess the appropriate raster layer data type

assessDataTypeGDAL()

Assess the appropriate raster layer data type for GDAL

basename2()

A version of base::basename that is NULL resistant

getUserTags() getCacheId() getArtifact()

Cache helpers

Cache() `%<%`

Cache method that accommodates environments, S4 methods, Rasters, & nested caching

.cacheMessage()

Create a custom cache message by class

createCache() saveToCache() loadFromCache() rmFromCache()

Create a new cache

checkAndMakeCloudFolderID()

Check for presence of checkFolderID (for Cache(useCloud))

.checkCacheRepo()

Check for cache repository info in ...

checkGDALVersion()

Check whether the system has a minimum version of GDAL available

checkPath()

Check directory path

checkoutVersion()

Clone, fetch, and checkout from GitHub.com repositories

clearStubArtifacts()

Clear erroneous archivist artifacts

cloudCheckOld()

Basic tool for using cloud-based caching

cloudDownload()

Download from cloud, if necessary

cloudSyncCacheOld()

Sync cloud with local Cache

cloudUpload()

Upload to cloud, if necessary

cloudWriteOld()

Basic tool for using cloud-based caching

compareNA()

NA-aware comparison of two vectors

convertPaths() convertRasterPaths()

Change the absolute path of a file

copySingleFile() copyFile()

Copy a file using robocopy on Windows and rsync on Linux/macOS

cropInputs()

Crop a Spatial* or Raster* object

.debugCache()

Attach debug info to return for Cache

determineFilename()

Determine filename, either automatically or manually

.removeCacheAtts()

Remove attributes that are highly varying

.requireNamespace()

Provide standard messaging for missing package dependencies

downloadFile()

A wrapper around a set of downloading functions

extractFromArchive()

Extract files from archive

fastMask()

Faster operations on rasters

getGDALVersion()

Check the GDAL version in use

.installPackages() trimVersionNumber()

Internal function to install packages

installVersions()

Install exact package versions from a package version text file & GitHub

installedVersions()

Determine versions all installed packages

linkOrCopy()

Hardlink, symlink, or copy a file

makeMemoisable() unmakeMemoisable()

Generic method to make or unmake objects memoisable

maskInputs()

Mask module inputs

mergeCache()

Merge two cache repositories together

movedCache()

Deal with moved cache issues

newLibPaths()

A shortcut to create a .libPaths() with only two directories

normPath()

Normalize filepath

objSize() objSizeSession()

Recursive object.size

`%C%`

A cache-aware pipe that does not mask with %>%

pkgDep() pkgDep2() pkgDepTopoSort()

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

.preDigestByClass()

Any miscellaneous things to do before .robustDigest and after FUN call

preProcess()

Download, Checksum, Extract files

.prefix() .suffix()

Add a prefix or suffix to the basename part of a file path

prepInputs()

Download and optionally post-process files

.prepareFileBackedRaster()

Copy the file-backing of a file-backed Raster* object

.prepareOutput()

Make any modifications to object recovered from cacheRepo

projectInputs()

Project Raster* or Spatial* or sf objects

reproducible-package

The reproducible package

reproducibleOptions()

reproducible options

retry()

A wrapper around try that retries on failure

searchFull() searchFullEx()

Search up the full scope for functions

.setSubAttrInList()

Set subattributes within a list by reference

.sortDotsUnderscoreFirst() .orderDotsUnderscoreFirst()

Sort or order any named object with dotted names and underscores first

studyAreaName()

Get a unique name for a given study area

.tagsByClass()

Add extra tags to an archive based on class

tempdir2() tempfile2()

Make a temporary sub-directory or file in that subdirectory

.unrarPath

The known path for unrar or 7z

clearCache() cc() showCache() keepCache()

Examining and modifying the cache

writeFuture()

Write to cache repository, using future::future

writeOutputs()

Write module inputs on disk