Package: simpleCache 0.5.0

Nathan Sheffield

simpleCache: Simply Caching R Objects

Provides intuitive functions for caching R objects, encouraging reproducible, restartable, and distributed R analysis. The user selects a location to store caches, and then provides nothing more than a cache name and instructions (R code) for how to produce the R object. Also provides some advanced options like environment assignments, recreating or reloading caches, and cluster compute bindings (using the 'batchtools' package) making it flexible enough for use in large-scale data analysis projects.

Authors:VP Nagraj [aut], Nathan Sheffield [aut, cre]

simpleCache_0.5.0.tar.gz
simpleCache_0.5.0.zip(r-4.7)simpleCache_0.5.0.zip(r-4.6)simpleCache_0.5.0.zip(r-4.5)
simpleCache_0.5.0.tgz(r-4.6-any)simpleCache_0.5.0.tgz(r-4.5-any)
simpleCache_0.5.0.tar.gz(r-4.7-any)simpleCache_0.5.0.tar.gz(r-4.6-any)
simpleCache_0.5.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
simpleCache/json (API)

# Install 'simpleCache' in R:
install.packages('simpleCache', repos = c('https://databio.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/databio/simplecache/issues

On CRAN:

Conda:

7.60 score 35 stars 1 packages 84 scripts 318 downloads 15 exports 0 dependencies

Last updated from:15e0f2bd46. Checks:8 OK, 1 ERROR. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK131
source / vignettesOK178
linux-release-x86_64OK133
macos-release-arm64OK180
macos-oldrel-arm64OK135
windows-develOK70
windows-releaseOK81
windows-oldrelERROR88
wasm-releaseOK98

Exports:addCacheSearchEnvironmentdeleteCachesgetCacheDirlistCachesloadCachesresetCacheSearchEnvironmentsetCacheBuildDirsetCacheDirsetSharedCacheDirsimpleCachesimpleCacheGlobalsimpleCacheOptionssimpleCacheSharedsimpleCacheSharedGlobalstoreCache

Dependencies:

An introduction to simpleCache
Your first cache | Comparison to base R save() and load() | Cache names | Creating but not loading caches | Loading multiple caches | Timing cache creating | Complicated code | Custom serialization backends
Rendered fromsimpleCacheIntroduction.Rmdusingknitr::rmarkdown

Last update: 2026-02-28
Started: 2015-04-13

Generating caches on a cluster
Generating caches in parallel using batchtools | Lock files
Rendered fromclusterCaches.Rmdusingknitr::rmarkdown

Last update: 2026-02-27
Started: 2017-08-03

Sharing caches across projects
Rendered fromsharingCaches.Rmdusingknitr::rmarkdown

Last update: 2017-08-22
Started: 2015-04-13

Readme and manuals

Help Manual

Help pageTopics
Provides intuitive functions for caching R objects, encouraging faster reproducible and restartable R analysissimpleCache-package _PACKAGE
Determine if a cache file is sufficiently old to warrant refresh..tooOld
Add a cache search environmentaddCacheSearchEnvironment
Deletes cachesdeleteCaches
Fetcher of the currently set cache directory.getCacheDir
Show available caches.listCaches
Loads pre-made cachesloadCaches
Sets global option of cache search environments to 'NULL'.resetCacheSearchEnvironment
This function takes a time in seconds and converts it to a more human-readable format, showing hours, minutes, or seconds, depending on how long the time is. Used by my implementation of tic()/toc().secToTime
Sets local cache build directory with scripts for building files.setCacheBuildDir
Sets a global variable specifying the default cache directory for 'simpleCache' calls.setCacheDir
Set shared cache directorysetSharedCacheDir
Create a new cache or load a previously created cache.simpleCache
Helper alias for loading caches into the global environment. simpleCache normally loads variables into the calling environment; this ensures that the variables are loaded in the global environment.simpleCacheGlobal
View simpleCache optionssimpleCacheOptions
Alias to default to a shared cache folder.simpleCacheShared
Helper alias for loading shared caches into the global environment.simpleCacheSharedGlobal
Stores as a cache an already-produced R objectstoreCache
Start a timertic
Check the time since the current timer was started with tic()toc