Skip to contents

Save the cache to a zip file, then to pipeline_caches_folder

stash_cache.Rd

Saves a pipeline cache to a zip file into the pipeline_caches_folder.

Usage

stash_cache(
  pipeline_caches_folder,
  cache_folder,
  file_prefix,
  dependency,
  release = FALSE
)

Arguments

pipeline_caches_folder

The folder into which the pipeline cache will be saved as a .zip file.

cache_folder

The cache folder that is to be zipped and saved. This path is interpreted relative to the working directory.

file_prefix

The prefix for the output file name.

dependency

The last target that should be executed before saving the cache. Not used internally.

release

A boolean telling whether to do a release. The cache is stored only for releases. Default is FALSE.

Value

If the cache was saved, the file name is returned. If release = FALSE, the string "Release not requested." is returned.

Details

Note that the dependency argument is not used internally. Rather, dependency exists to ensure that the pipeline executes the right targets before saving the cache.