Check for cache repository info in ... — .checkCacheRepo • reproducible

This is a generic definition that can be extended according to class. Normally, checkPath can be called directly, but does not have class-specific methods.

.checkCacheRepo(
  object,
  create = FALSE,
  verbose = getOption("reproducible.verbose", 1)
)

# S4 method for ANY
.checkCacheRepo(
  object,
  create = FALSE,
  verbose = getOption("reproducible.verbose", 1)
)

Arguments

object: An R object
create: Logical. If TRUE, then it will create the path for cache.
verbose: Numeric, -1 silent (where possible), 0 being very quiet, 1 showing more messaging, 2 being more messaging, etc. Default is 1. Above 3 will output much more information about the internals of Caching, which may help diagnose Caching challenges. Can set globally with an option, e.g., options('reproducible.verbose' = 0) to reduce to minimal

Value

A character string with a path to a cache repository.

Author

Eliot McIntire

Examples

a <- "test"
.checkCacheRepo(a) # no cache repository supplied
#> No cacheRepo supplied and getOption('reproducible.cachePath') is inside a temporary directory;
#>   this will not persist across R sessions.