A Set of Tools that Enhance Reproducibility of R Code

Documentation for package ‘reproducible’ version 1.2.16

Help Pages

The 'reproducible' package

-- A --

asPath	Coerce a character string to a class "Path"
asPath.character	Coerce a character string to a class "Path"
asPath.null	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

-- B --

basename2

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

-- C --

Cache	Saves a wide variety function call outputs to disk and optionally RAM, for recovery later
CacheDBFile	Functions to create and work with a cache
CacheDBTableName	Functions to create and work with a cache
CacheDigest	The exact digest function that 'Cache' uses
CacheIsACache	Functions to create and work with a cache
CacheStorageDir	Functions to create and work with a cache
CacheStoredFile	Functions to create and work with a cache
cc	Examining and modifying the cache
checkAndMakeCloudFolderID	Check for presence of 'checkFolderID' (for 'Cache(useCloud)')
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	Deprecated
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	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
createCache	Functions to create and work with a cache
cropInputs	Crop a Spatial* or Raster* object
cropInputs.default	Crop a Spatial* or Raster* object
cropInputs.sf	Crop a Spatial* or Raster* object
cropInputs.spatialClasses	Crop a Spatial* or Raster* object
cropTo	Transform a GIS dataset so it has the properties (extent, projection, mask) of another

-- 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 (DEPRECATED as 'terra::mask' is fast)
Filenames	Return the filename(s) from a Raster* object
Filenames-method	Return the filename(s) from a Raster* object
fixErrorsTerra	Fix common errors in GIS layers, using 'terra'

-- K --

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

-- L --

linkOrCopy	Hardlink, symlink, or copy a file
loadFromCache	Functions to create and work with a cache

-- M --

maskInputs	Mask module inputs
maskInputs.Raster	Mask module inputs
maskInputs.sf	Mask module inputs
maskInputs.Spatial	Mask module inputs
maskInputs.SpatRaster	Mask module inputs
maskInputs.SpatVector	Mask module inputs
maskTo	Transform a GIS dataset so it has the properties (extent, projection, mask) of another
mergeCache	Merge two cache repositories together
mergeCache-method	Merge two cache repositories together
messageDF	Use message to print a clean square data structure
movedCache	Deal with moved cache issues

-- N --

normPath	Normalize filepath
normPath-method	Normalize filepath

-- O --

objSize	Wrapper around 'lobstr::obj_size'
objSizeSession	Wrapper around 'lobstr::obj_size'

-- P --

paddedFloatToChar	Convert numeric to character with padding
Path-class	Coerce a character string to a class "Path"
pipe	A cache-aware pipe (currently not working)
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.spatialClasses	Generic function to post process objects
postProcessTerra	Transform a GIS dataset so it has the properties (extent, projection, mask) of another
prepInputs	Download and optionally post-process files
preProcess	Download, Checksum, Extract files
preProcessParams	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
projectInputs.SpatRaster	Project Raster* or Spatial* or 'sf' objects
projectInputs.SpatVector	Project Raster* or Spatial* or 'sf' objects
projectTo	Transform a GIS dataset so it has the properties (extent, projection, mask) of another

-- R --

reproducible	The 'reproducible' package
reproducibleOptions	'reproducible' options
retry	A wrapper around 'try' that retries on failure
rmFromCache	Functions to create and work with a cache

-- S --

saveToCache	Save an object to Cache
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
spatialClasses	The 'spatialClasses' class
spatialClasses-class	The 'spatialClasses' class
studyAreaName	Get a unique name for a given study area
studyAreaName-method	Get a unique name for a given study area
suffix	Add a prefix or suffix to the basename part of a file path

-- T --

tempdir2	Make a temporary (sub-)directory
tempfile2	Make a temporary file in a temporary (sub-)directory

-- U --

unrarPath

The known path for unrar or 7z

-- W --

writeFuture	Write to cache repository, using 'future::future'
writeOutputs	Write module inputs on disk
writeOutputs.default	Write module inputs on disk
writeOutputs.quosure	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
writeTo	Transform a GIS dataset so it has the properties (extent, projection, mask) of another

-- misc --

%<%	A cache-aware pipe (currently not working)
%C%	A cache-aware pipe (currently not working)
.debugCache	Attach debug info to return for Cache
.file.move	Move a file to a new location
.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
.removeCacheAtts	Remove attributes that are highly varying
.requireNamespace	Provide standard messaging for missing package dependencies
.setSubAttrInList	Set subattributes within a list by reference
.suffix	Add a prefix or suffix to the basename part of a file path
.unrarPath	The known path for unrar or 7z