Package 'cache'

Title: Cache and Retrieve Computation Results
Description: Easily cache and retrieve computation results. The package works seamlessly across interactive R sessions, R scripts and Rmarkdown documents.
Authors: Olivier Binette [aut, cre]
Maintainer: Olivier Binette <[email protected]>
License: MIT + file LICENSE
Version: 0.0.3
Built: 2024-10-24 02:57:39 UTC
Source: https://github.com/olivierbinette/cache

Help Index


Cache or Retrieve Computation Results

Description

Cache or retrieve an evaluated expression. Results are always made available in the current environment.

Usage

cache(..., .cachedir = here(".cache-R"), .rerun = FALSE)

Arguments

...

Named expressions to be cached or retrieved.

.cachedir

Directory where cache files are stored. Default is a directory called .cache-R located at the project root.

.rerun

Whether or not to clear the cache and re-run the provided expressions. Defaults to FALSE.

Examples

tmp <- tempdir()

# Takes 1 second to execute
cache(a = {
  Sys.sleep(1)
  "Hello World"
}, .cachedir = tmp)

# Executes instantly
cache(a = {
  Sys.sleep(1)
  "Hello World"
}, .cachedir = tmp)

# Result is available in the current environment
print(a)

# Re-run the expression
cache(a = {
  Sys.sleep(1)
  "Hello World"
}, .cachedir = tmp, .rerun = TRUE)

Load cached objects from cache directory

Description

Load cached objects from cache directory

Usage

cache_load(objnames = "*", .cachedir = here(".cache-R"))

Arguments

objnames

character list of object names to load.

.cachedir

path to cache directory. Defaults to the directory named .cache-R at the project root.