Cache the results of a function so that when you call it again with the same arguments it returns the pre-computed value.
If a function is called multiple times with the same input, you can
often speed things up by keeping a cache of known answers that it can
retrieve. This is called memoisation http://en.wikipedia.org/wiki/Memoization.
memoise package provides a simple syntax
mf <- memoise(f)
mf(), a memoised wrapper around
f(). You can clear
and you can test whether a function is memoised with
is.memoised(mf) # TRUEis.memoised(f) # FALSE
memoise also supports external caching in addition to the default in-memory caches.
cache_filesystem()allows caching using files on a local filesystem. You can point this to a shared file such as dropbox or google drive to share caches between systems.
cache_s3()allows caching on Amazon S3
cache_s3() to cache objects using s3 storage. Requires you to specify
a bucket using
cache_name. When creating buckets, they must be unique among
all s3 users when created.
Sys.setenv("AWS_ACCESS_KEY_ID" = "<access key>","AWS_SECRET_ACCESS_KEY" = "<access secret>")mrunif <- memoise(runif, cache = cache_s3("<unique bucket name>"))mrunif(10) # First run, saves cachemrunif(10) # Loads cache, results should be identical
cache_filesystem can be used for a file system cache. This is useful for
preserving the cache between R sessions as well as sharing between systems
when using a shared or synced files system such as Dropbox or Google Drive.
fc <- cache_filesystem("~/.cache")mrunif <- memoise(runif, cache = fc)mrunif(20) # Results stored in local filedbc <- cache_filesystem("~/Dropbox/.rcache")mrunif <- memoise(runif, cache = dbc)mrunif(20) # Results stored in Dropbox .rcache folder which will be synced between computers.gdc <- cache_filesystem("~/Google Drive/.rcache")mrunif <- memoise(runif, cache = gdc)mrunif(20) # Results stored in Google Drive .rcache folder which will be synced between computers.
cache=argument to specify an external cache. Two types of caches are available,
cache_s3()for amazon S3 and
cache_filesystem()for a file system cache (#25, @danielecook).
memoise()now signals an error if an already memoised function is used as input (#4, @richierocks).
has_cache()function added which returns a boolean depending on if the given call is cached or not (#10, @dkesh).
memoiseis called. (Otherwise, the old behavior is invoked, with a warning.) (#14, @krlmlr)
is.memoisednow checks if the argument is a function.