createCache | R Documentation |
These are not intended for normal use.
createCache(
cachePath = getOption("reproducible.cachePath"),
drv = getDrv(getOption("reproducible.drv", NULL)),
conn = getOption("reproducible.conn", NULL),
force = FALSE,
verbose = getOption("reproducible.verbose")
)
loadFromCache(
cachePath = getOption("reproducible.cachePath"),
cacheId,
preDigest,
fullCacheTableForObj = NULL,
format = getOption("reproducible.cacheSaveFormat", "rds"),
.functionName = NULL,
.dotsFromCache = NULL,
drv = getDrv(getOption("reproducible.drv", NULL)),
conn = getOption("reproducible.conn", NULL),
verbose = getOption("reproducible.verbose")
)
rmFromCache(
cachePath = getOption("reproducible.cachePath"),
cacheId,
drv = getDrv(getOption("reproducible.drv", NULL)),
conn = getOption("reproducible.conn", NULL),
format = getOption("reproducible.cacheSaveFormat", "rds")
)
CacheDBFile(
cachePath = getOption("reproducible.cachePath"),
drv = getDrv(getOption("reproducible.drv", NULL)),
conn = getOption("reproducible.conn", NULL)
)
CacheStorageDir(cachePath = getOption("reproducible.cachePath"))
CacheStoredFile(
cachePath = getOption("reproducible.cachePath"),
cacheId,
format = NULL,
obj = NULL
)
CacheDBTableName(
cachePath = getOption("reproducible.cachePath"),
drv = getDrv(getOption("reproducible.drv", NULL))
)
CacheIsACache(
cachePath = getOption("reproducible.cachePath"),
create = FALSE,
drv = getDrv(getOption("reproducible.drv", NULL)),
conn = getOption("reproducible.conn", NULL)
)
cachePath |
A path describing the directory in which to create the database file(s) |
drv |
A driver, passed to |
conn |
an optional DBIConnection object, as returned by dbConnect(). |
force |
Logical. Should it create a cache in the |
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., |
cacheId |
The cacheId or otherwise digested hash value, as character string. |
preDigest |
The list of |
fullCacheTableForObj |
The result of |
format |
The text string representing the file extension used normally by
different save formats; currently only |
.functionName |
Optional. Used for messaging when this function is called from |
.dotsFromCache |
Optional. Used internally. |
obj |
The optional object that is of interest; it may have an attribute "saveRawFile" that would be important. |
create |
Logical. Currently only affects non RQSLite default drivers. If this
is |
createCache
function will create a Cache folder structure and necessary files, based on
the particular drv
or conn
provided.
loadFromCache
is a function to get a single object from the cache, given its cacheId
.
rmFromCache
removes one or more items from the cache, and updates the cache
database files.
CacheStoredFile
returns the file path to the file with the specified hash value.
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.
createCache
does not return a value; it is called for side effects.
loadFromCache
returns the object from the cache that has the particular cacheId
.
rmFromCache
has no return value; it is called for its side effects.
CacheDBFile
returns the name of the database file for a given Cache,
when useDBI() == FALSE
, or NULL
if TRUE
.
CacheDBFiles
(i.e,. plural) returns the name of all the database files for
a given Cache when useDBI() == TRUE
, or NULL
if FALSE
CacheStorageDir
returns the name of the directory where cached objects are
stored.
CacheStoredFile
returns the name of the file in which the cacheId object is stored.
This can be loaded to memory with e.g., loadFile
.
CacheDBTableName
returns the name of the table inside the SQL database, if that
is being used.
CacheIsACache
returns a logical indicating whether the cachePath
is currently
a reproducible
cache database.
data.table::setDTthreads(2)
newCache <- tempdir2()
createCache(newCache)
out <- Cache(rnorm(1), cachePath = newCache)
cacheId <- gsub("cacheId:", "", attr(out, "tags"))
loadFromCache(newCache, cacheId = cacheId)
rmFromCache(newCache, cacheId = cacheId)
# clean up
unlink(newCache, recursive = TRUE)
data.table::setDTthreads(2)
newCache <- tempdir2()
# Given the drv and conn, creates the minimum infrastructure for a cache
createCache(newCache)
CacheDBFile(newCache) # identifies the database file
CacheStorageDir(newCache) # identifies the directory where cached objects are stored
out <- Cache(rnorm(1), cachePath = newCache)
cacheId <- gsub("cacheId:", "", attr(out, "tags"))
CacheStoredFile(newCache, cacheId = cacheId)
# The name of the table inside the SQL database
CacheDBTableName(newCache)
CacheIsACache(newCache) # returns TRUE
# clean up
unlink(newCache, recursive = TRUE)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.