Package: simpleCache 0.4.2

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.4.2.tar.gz
simpleCache_0.4.2.zip(r-4.5)simpleCache_0.4.2.zip(r-4.4)simpleCache_0.4.2.zip(r-4.3)
simpleCache_0.4.2.tgz(r-4.4-any)simpleCache_0.4.2.tgz(r-4.3-any)
simpleCache_0.4.2.tar.gz(r-4.5-noble)simpleCache_0.4.2.tar.gz(r-4.4-noble)
simpleCache_0.4.2.tgz(r-4.4-emscripten)simpleCache_0.4.2.tgz(r-4.3-emscripten)
simpleCache.pdf |simpleCache.html✨
simpleCache/json (API)
NEWS

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

Peer review:

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

On CRAN:

7.51 score 34 stars 1 packages 71 scripts 180 downloads 15 exports 0 dependencies

Last updated 4 years agofrom:806f818dc2. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 13 2024
R-4.5-winOKOct 13 2024
R-4.5-linuxOKOct 13 2024
R-4.4-winOKOct 13 2024
R-4.4-macOKOct 13 2024
R-4.3-winOKOct 13 2024
R-4.3-macOKOct 13 2024

Exports:addCacheSearchEnvironmentdeleteCachesgetCacheDirlistCachesloadCachesresetCacheSearchEnvironmentsetCacheBuildDirsetCacheDirsetSharedCacheDirsimpleCachesimpleCacheGlobalsimpleCacheOptionssimpleCacheSharedsimpleCacheSharedGlobalstoreCache

Dependencies:

An introduction to simpleCache

Nathan Sheffield

Rendered fromsimpleCacheIntroduction.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2018-03-01
Started: 2015-04-13

Generating caches on a cluster

Nathan Sheffield

Rendered fromclusterCaches.Rmdusingknitr::rmarkdownon Oct 13 2024.

Last update: 2017-08-21
Started: 2017-08-03

Sharing caches across projects

Nathan Sheffield

Rendered fromsharingCaches.Rmdusingknitr::rmarkdownon Oct 13 2024.

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