drake (version 6.2.1)

failed: List the targets that failed in the last call to make().

Description

Together, functions failed and diagnose() should eliminate the strict need for ordinary error messages printed to the console.

Usage

failed(path = getwd(), search = TRUE, cache = drake::get_cache(path =
  path, search = search, verbose = verbose),
  verbose = drake::default_verbose(), upstream_only = FALSE)

Arguments

path

Root directory of the drake project, or if search is TRUE, either the project root or a subdirectory of the project. Ignored if a cache is supplied.

search

logical. If TRUE, search parent directories to find the nearest drake cache. Otherwise, look in the current working directory only. Ignored if a cache is supplied.

cache

drake cache. See new_cache(). If supplied, path and search are ignored.

verbose

logical or numeric, control printing to the console. Use pkgconfig to set the default value of verbose for your R session: for example, pkgconfig::set_config("drake::verbose" = 2).

• 0 or FALSE: print nothing.

• 1 or TRUE: print only targets to build.

• 2: also print checks and cache info.

• 3: also print any potentially missing items.

• 4: also print imports and writes to the cache.

upstream_only

logical, whether to list only those targets with no failed dependencies. Naturally accompanies make(keep_going = TRUE).

Value

A character vector of target names.

See Also

diagnose(), drake_get_session_info(), built(), imported(), readd(), drake_plan(), make()

Examples

# NOT RUN {
test_with_dir("Quarantine side effects.", {
load_mtcars_example() # Get the code with drake_example("mtcars").
make(my_plan) # Run the project, build the targets.
failed() # Should show that no targets failed.
# Build a workflow plan doomed to fail:
bad_plan <- drake_plan(x = function_doesnt_exist())
try(make(bad_plan), silent = TRUE) # error
failed() # "x"
diagnose(x) # Retrieve the cached error log of x.
})
# }