diff --git a/NAMESPACE b/NAMESPACE index 6462911..38ae188 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,6 +1,7 @@ # Generated by roxygen2: do not edit by hand export(addCacheSearchEnvironment) +export(deleteCaches) export(listCaches) export(loadCaches) export(resetCacheSearchEnvironment) diff --git a/man/deleteCaches.Rd b/man/deleteCaches.Rd new file mode 100644 index 0000000..9944dae --- /dev/null +++ b/man/deleteCaches.Rd @@ -0,0 +1,43 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/deleteCache.R +\name{deleteCaches} +\alias{deleteCaches} +\title{Deletes caches} +\usage{ +deleteCaches(cacheNames, cacheDir = getOption("RCACHE.DIR"), force = FALSE) +} +\arguments{ +\item{cacheNames}{Name(s) of the cache to delete} + +\item{cacheDir}{Directory where caches are kept} + +\item{force}{Force deletion without user prompt} +} +\description{ +Given a cache name, this function will attempt to delete the cache of that +name on disk. +} +\examples{ +# choose location to store caches +cacheDir = tempdir() +cacheDir +setCacheDir(cacheDir) + +# build some caches +simpleCache("normSample", { rnorm(5e3, 0,1) }, recreate=TRUE, timer=TRUE) +simpleCache("normSample", { rnorm(5e3, 0,1) }) +simpleCache("normSample", { rnorm(5e3, 0,1) }, reload=TRUE) + +# storing a cache after-the-fact +normSample2 = rnorm(10, 0, 1) +storeCache("normSample2") + +# what's available? +listCaches() + +# load a cache +simpleCache("normSample") + +# load multiples caches +loadCaches(c("normSample", "normSample2"), reload=TRUE) +} diff --git a/man/simpleCacheGlobal.Rd b/man/simpleCacheGlobal.Rd index bd559dd..da705b2 100644 --- a/man/simpleCacheGlobal.Rd +++ b/man/simpleCacheGlobal.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/helpers.R +% Please edit documentation in R/sharedCaches.R \name{simpleCacheGlobal} \alias{simpleCacheGlobal} \title{Helper alias for loading caches into the global environment. diff --git a/man/simpleCacheShared.Rd b/man/simpleCacheShared.Rd index 7a8a991..ff0b21f 100644 --- a/man/simpleCacheShared.Rd +++ b/man/simpleCacheShared.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/helpers.R +% Please edit documentation in R/sharedCaches.R \name{simpleCacheShared} \alias{simpleCacheShared} \title{Alias to default to a shared cache folder.} diff --git a/man/simpleCacheSharedGlobal.Rd b/man/simpleCacheSharedGlobal.Rd index 6783a2d..b3a06cb 100644 --- a/man/simpleCacheSharedGlobal.Rd +++ b/man/simpleCacheSharedGlobal.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/helpers.R +% Please edit documentation in R/sharedCaches.R \name{simpleCacheSharedGlobal} \alias{simpleCacheSharedGlobal} \title{Helper alias for loading shared caches into the global environment.}