A collection of low level tools for Cache — CacheDBFile • reproducible

These are not intended for normal use.

CacheDBFile(
  cachePath = getOption("reproducible.cachePath"),
  drv = getOption("reproducible.drv", RSQLite::SQLite()),
  conn = getOption("reproducible.conn", NULL)
)

CacheStorageDir(cachePath = getOption("reproducible.cachePath"))

CacheStoredFile(
  cachePath = getOption("reproducible.cachePath"),
  hash,
  format = getOption("reproducible.cacheSaveFormat", "rds")
)

CacheDBTableName(
  cachePath = getOption("reproducible.cachePath"),
  drv = getOption("reproducible.drv", RSQLite::SQLite())
)

CacheIsACache(
  cachePath = getOption("reproducible.cachePath"),
  create = FALSE,
  drv = getOption("reproducible.drv", RSQLite::SQLite()),
  conn = getOption("reproducible.conn", NULL)
)

Arguments

cachePath	A path describing the directory in which to create the database file(s)
drv	an object that inherits from DBIDriver, or an existing DBIConnection object (in order to clone an existing connection).
conn	A DBIConnection object, as returned by `dbConnect()`.
hash	The cacheId or otherwise digested hash value, as character string.
format	The text string representing the file extension used normally by different save formats; currently only `"rds"` or `"qs"`. Defaults to `getOption("reproducible.cacheSaveFormat", "rds")`
create	Logical. Currently only affects non RQSLite default drivers. If this is `TRUE` and there is no Cache database, the function will create one.

Details

CacheStoredFile returns the file path to the file with the specified hash value.

CacheIsACache returns a logical of whether the specified cachePath is actually a functioning cache.