drake_cache_log_file: Generate a flat text log file to represent the state of the...

In wlandau-lilly/drake: A Pipeline Toolkit for Reproducible Computation at Scale

Generate a flat text log file to represent the state of the cache.

Description

Deprecated on 2019-03-09.

Usage

drake_cache_log_file(
  file = "drake_cache.log",
  path = getwd(),
  search = TRUE,
  cache = drake::get_cache(path = path, search = search, verbose = verbose),
  verbose = 1L,
  jobs = 1L,
  targets_only = FALSE
)

Arguments

file	character scalar, name of the flat text log file.
path	Path to a drake cache (usually a hidden ⁠.drake/⁠ folder) or NULL.
search	Deprecated.
cache	drake cache. See new_cache(). If supplied, path is ignored.
verbose	Deprecated on 2019-09-11.
jobs	Number of jobs/workers for parallel processing.
targets_only	Logical, whether to output information only on the targets in your workflow plan data frame. If targets_only is FALSE, the output will include the hashes of both targets and imports.

Details

Calling this function to create a log file and later calling make() makes the log file out of date. Therefore, we recommend using make() with the cache_log_file argument to create the cache log. This way ensures that the log is always up to date with make() results.

Value

There is no return value, but a log file is generated.

See Also

drake_cache_log(), make(), get_cache()

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