cachingEngine: CachingEngine Constructor

Description Usage Arguments Value Author(s) See Also

Description

Function for creating a Caching engine with specific behaviors

Usage

1
2
3
4
cachingEngine(base_dir = "./r_caches", tmp_base_dir = tempdir(),
  write_allowed = TRUE, write_on_cache = FALSE, gdevs = list(png),
  eval_fun = parseWithVis, return_handler = withVisHandler,
  populate = TRUE)

Arguments

base_dir

character value . Path to which permanent caches should be written (if applicable)

tmp_base_dir

character value. Path to which temporary caches should be written (if applicable)

write_allowed

logical. Should the engine allow caches to be written to disk. Defaults to TRUE

write_on_cache

logical. Should the engine write caches to disk immediately upon creation. Defaults to FALSE

gdevs

list. A list of graphics device functions to use when caching plots. Defaults to list(png)

eval_fun

function. The evaluator function to be used when no cache is found. Defaults to parseWithVis.

return_handler

function. The function to process values returned by eval_fun. This function will be called on values returned from eval_fun directly and those loaded from cache. Defaults to withVisHandler which supports plot caching.

populate

logical. Should the engine include existing caches from base_dir upon creation. Defaults to TRUE

Value

A CachingEngine object suitable for use with evalWithCache

Author(s)

Gabriel Becker

See Also

evalWithCache


gmbecker/RCacheSuite documentation built on May 17, 2019, 6:42 a.m.