drake (version 5.0.0)

deps: List the dependencies of a function, workflow plan command, or knitr report source file.

Description

Intended for debugging and checking your project. The dependency structure of the components of your analysis decides which targets are built and when.

Usage

deps(x)

Arguments

x

Either a function or a string. Strings are commands from your workflow plan data frame.

Value

A character vector, names of dependencies. Files wrapped in single quotes. The other names listed are functions or generic R objects.

Details

If the argument is a single-quoted string that points to a dynamic knitr report, the dependencies of the expected compiled output will be given. For example, deps("'report.Rmd'") will return target names found in calls to loadd() and readd() in active code chunks. These targets are needed in order to run knit('report.Rmd') to produce the output file 'report.md', so technically, they are dependencies of 'report.md', not 'report.Rmd'

Examples

# NOT RUN {
# Your workflow likely depends on functions in your workspace.
f <- function(x, y){
  out <- x + y + g(x)
  saveRDS(out, 'out.rds')
}
# Find the dependencies of f. These could be R objects/functions
# in your workspace or packages. Any file names or target names
# will be ignored.
deps(f)
# Define a workflow plan data frame that uses your function f().
my_plan <- drake_plan(
  x = 1 + some_object,
  my_target = x + readRDS('tracked_input_file.rds'),
  return_value = f(x, y, g(z + w))
)
# Get the dependencies of workflow plan commands.
# Here, the dependencies could be R functions/objects from your workspace
# or packages, imported files, or other targets in the workflow plan.
deps(my_plan$command[1])
deps(my_plan$command[2])
deps(my_plan$command[3])
# }
# NOT RUN {
test_with_dir("Quarantine side effects.", {
load_basic_example() # Get the code with drake_example("basic").
# Dependencies of the knitr-generated targets like 'report.md'
# include targets/imports referenced with `readd()` or `loadd()`.
deps("'report.Rmd'")
})
# }