rescue_cache: Try to repair a drake cache that is prone to throwing...
In wlandau-lilly/drake: A Pipeline Toolkit for Reproducible Computation at Scale

rescue_cache

R Documentation

Try to repair a drake cache that is prone to throwing `storr`-related errors.

Description

Sometimes, storr caches may have dangling orphaned files that prevent you from loading or cleaning. This function tries to remove those files so you can use the cache normally again.

Usage

rescue_cache(
  targets = NULL,
  path = NULL,
  search = NULL,
  verbose = NULL,
  force = FALSE,
  cache = drake::drake_cache(path = path),
  jobs = 1,
  garbage_collection = FALSE
)

Arguments

`targets`	Character vector, names of the targets to rescue. As with many other drake utility functions, the word `target` is defined generally in this case, encompassing imports as well as true targets. If `targets` is `NULL`, everything in the cache is rescued.
`path`	Character. Set `path` to the path of a `storr::storr_rds()` cache to retrieve a specific cache generated by `storr::storr_rds()` or `drake::new_cache()`. If the `path` argument is `NULL`, `drake_cache()` searches up through parent directories to find a folder called `⁠.drake/⁠`.
`search`	Deprecated.
`verbose`	Deprecated on 2019-09-11.
`force`	Deprecated.
`cache`	A `storr` cache object.
`jobs`	Number of jobs for light parallelism (disabled on Windows).
`garbage_collection`	Logical, whether to do garbage collection as a final step. See `drake_gc()` and `clean()` for details.

Value

Nothing.

Examples

## Not run: 
isolate_example("Quarantine side effects.", {
if (suppressWarnings(require("knitr"))) {
load_mtcars_example() # Get the code with drake_example("mtcars").
make(my_plan) # Run the project, build targets. This creates the cache.
# Remove dangling cache files that could cause errors.
rescue_cache(jobs = 2)
# Alternatively, just rescue targets 'small' and 'large'.
# Rescuing specific targets is usually faster.
rescue_cache(targets = c("small", "large"))
}
})

## End(Not run)

wlandau-lilly/drake documentation built on Dec. 3, 2024, 11:09 p.m.