Learn R Programming

⚠️There's a newer version (2.1.2) of this package.Take me there.

reproducible

A set of tools for R that enhance reproducibility beyond package management. Built on top of git2r and archivist, this package aims at making high-level, robust, machine and OS independent tools for making deeply reproducible and reusable content in R. This extends beyond the package management utilities of packrat and checkpoint by including tools for caching and accessing GitHub repositories.

Installation

Current release (on CRAN)

Install from CRAN:

install.packages("reproducible")

Install from GitHub:

#install.packages("devtools")
library("devtools")
install_github("PredictiveEcology/reproducible", dependencies = TRUE) 

Development version

Install from GitHub:

#install.packages("devtools")
library("devtools")
install_github("PredictiveEcology/reproducible", ref = "development", dependencies = TRUE) 

Contributions

Please see CONTRIBUTING.md for information on how to contribute to this project.

Copy Link

Version

Install

install.packages('reproducible')

Monthly Downloads

2,317

Version

0.2.11

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Eliot J B

Last Published

November 19th, 2019

Functions in reproducible (0.2.11)

fixErrors

Do some minor error fixing
isWindows

Test whether system is Windows
available.packagesMem

Memoised version of available.packages
copySingleFile

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

Check a neededFile for commonly needed auxiliary files
getGDALVersion

Check the GDAL version in use
basename2

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

Hardlink, symlink, or copy a file
cropInputs

Crop a Spatial* or Raster* object
checkGDALVersion

Check whether the system has a minimum version of GDAL available
getFunctionName

A set of helpers for Cache
retry

A wrapper around try that retries on failure
postProcess

Generic function to post process objects
pkgSnapshot

Take a snapshot of all the packages and version numbers
reproducible-package

The reproducible package
cloudUpload

Upload to cloud, if necessary
.cacheMessage

Create a custom cache message by class
reproducibleOptions

reproducible options
.purge

Purge individual line items from checksums file
cloudSyncCacheOld

Sync cloud with local Cache
checkAndMakeCloudFolderID

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

Attach debug info to return for Cache
Checksums

Calculate checksum
assessDataType

Assess the appropriate raster layer data type
checkoutVersion

Clone, fetch, and checkout from GitHub.com repositories
.checkCacheRepo

Check for cache repository info in ...
.digest

Calculate the hashes of multiple files
clearStubArtifacts

Clear erroneous archivist artifacts
dlGeneric

Download file from generic source url
compareNA

NA-aware comparison of two vectors
cloudCheckOld

Basic tool for using cloud-based caching
.grepSysCalls

Grep system calls
maskInputs

Mask module inputs
assessDataTypeGDAL

Assess the appropriate raster layer data type for GDAL
cloudDownload

Download from cloud, if necessary
guessAtTarget

Try to pick a file to load
mergeCache

Merge two cache repositories together
determineFilename

Determine filename, either automatically or manually
convertPaths

Change the absolute path of a file
dlGoogle

Download file from Google Drive
Cache

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

Cache helpers
.checkGitConfig

Check global git config file
fastMask

Faster operations on rasters
extractFromArchive

Extract files from archive
installedVersions

Determine versions all installed packages
checkPath

Check directory path
isInteractive

Alternative to interactive() for unit testing
cloudUploadFromCache

Upload a file to cloud directly from local cacheRepo
pkgDep

Determine package dependencies, first looking at local filesystem
.formalsNotInCurrentDots

Identify which formals to a function are not in the current ...
.objSizeInclEnviros

Determine object size of all objects inside environments
objSize

Recursive object.size
newLibPaths

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

Download and optionally post process files
cloudWriteOld

Basic tool for using cloud-based caching
.listFilesInArchive

List files in either a .zip or or .tar file
makeMemoisable

Generic method to make or unmake objects memoisable
.removeCacheAtts

Remove attributes that are highly varying
downloadFile

A wrapper around a set of downloading functions
normPath

Normalize filepath
writeOutputs

Write module inputs on disk
.sortDotsUnderscoreFirst

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

Set subattributes within a list by reference
.prepareFileBackedRaster

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

Internal function to install packages
package_dependenciesMem

Memoised version of package_dependencies
pipe

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

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

Make any modifications to object recovered from cacheRepo
projectInputs

Project Raster* or Spatial* or sf objects
.robustDigest

Create reproducible digests of objects in R
searchFull

Search up the full scope for functions
.pkgEnv

The reproducible package environment
writeFuture

Write to archivist repository, using future::future
.prefix

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

Examining and modifying the cache
testForArchiveExtract

Returns unrar path and creates a shortcut as .unrarPath Was not incorporated in previous function so it can be used in the tests
preProcess

Download, Checksum, Extract files
unrarPath

The known path for unrar or 7z
.getTargetCRS

Hierarchically get crs from Raster*, Spatial*
.preDigestByClass

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

Add extra tags to an archive based on class
tempdir2

Make a temporary sub-directory
CacheDigest

The exact digest function that Cache uses
Filenames

Return the filename(s) from a Raster* object
Path-class

Coerce a character string to a class "Path"
Copy

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

Add an attribute to an object indicating which named elements change
Require

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

Deprecated
.addTagsToOutput

Add tags to object
archiveExtractBinary

Tests if unrar or 7zip exist