A Pipeline Toolkit for Reproducible Computation at Scale
Load the main example.
read_drake_meta
Type summary printing
List failed targets.
Declare input files and directories.
Declare output files and directories.
Read the plan from the cache
RStudio addin for r_vis_drake_graph()
List running targets.
Show a Sankey graph of your drake project.
Internal function with a drake_config() argument
session
Shell file for Makefile parallelism
drake now only uses one hash algorithm per cache.
List all the built targets (non-imports) in the cache.
List all the storr cache namespaces used by drake.
Return the file path where the cache is stored, if applicable.
Deprecated: clean the main example from drake_example("main")
Return the default long hash algorithm for make().
Default arguments of Makefile parallelism
Default Makefile command
Default parallel backend
Default Makefile recipe command
Return the default short hash algorithm for make().
default_system2_args
Default verbosity
States of the dependencies of a target
deprecate_wildcard
deps
Get the state of the cache.
Create the nodes data frame used in the legend of the graph visualizat...
load_basic_example
Report any import objects required by your drake_plan plan but missing...
Internal function with a drake_config() argument
Names of old parallel backends
plan
Specialized wildcard for analyses
plan_drake
read_config
Combine targets
Session info of the last call to make().
Visualize the workflow with ggraph/ggplot2
Dependencies of a knitr report
analyses
Show the analysis wildcard used in plan_summaries().
as_drake_filename
as_file
List the available hash algorithms for drake caches.
backend
Row-bind together drake plans
Function build_drake_graph
build_graph
See the time it took to build each target.
Internal function with a drake_config() argument
List targets in the cache.
List targets in both the plan and the cache.
List targets in the cache but not the plan.
Cancel a target mid-build
Cancel a target mid-build under some condition
check
Check a workflow plan data frame for obvious errors.
Invalidate and deregister targets.
Clean the mtcars example from drake_example("mtcars")
Auxiliary storr namespaces
Build a target using the clustermq backend
Turn a script into a function.
Turn an R script file or knitr / R Markdown report into a drake pl...
config
Configure the hash algorithms, etc. of a drake cache.
dataframes_graph
Show the dataset wildcard used in plan_analyses() and `plan_summarie...
Run a function in debug mode.
Return the default title for graph visualizations
Prepare the workflow graph for visualization
List the dependencies of a function or command
Find the drake dependencies of a dynamic knitr report target.
Find out why a target is out of date.
Internal function with a drake_config() argument
List the dependencies of a target
Internal function with a drake_config() argument
See the dependencies of a target
Internal function
History and provenance
Get diagnostic metadata on a target.
Do the prework in the preworkargument to make().
doc_of_function_call
drake: A pipeline toolkit for reproducible computation at scale.
Get a template file for execution on a cluster.
Build/process a single target or import.
Internal function with a drake_config() argument
Get the cache of a drake project.
Generate a flat text log file to represent the state of the cache.
List cancelled targets.
Ending of _drake.R for r_make() and friends
Run a single target's command in debug mode.'
drake_deps helper
drake_deps_ht helper
List done targets.
examples_drake
expand
Declare knitr/rmarkdown source files as dependencies.
Get the environment where drake builds targets
Download the files of an example drake project.
List the names of all the drake examples.
List failed targets.
Do garbage collection on the drake cache.
Write a template file for deploying work to a cluster / job scheduler.
List the available example template files for deploying work to a clus...
Compute the initial pre-build metadata of a target or import.
Show drake's color palette.
Create a drake plan for the plan argument of make().
Show the code required to produce a given drake plan
Deprecated: create replicates of targets.
Get the build progress of your targets
Put quotes around each element of a character vector.
List running targets.
Write an example _drake.R script to the current working directory.
Session info of the last call to make().
drake_settings helper
Deprecated: expose package functions and objects for analysis with dra...
Take a strategic subset of a dataset.
Turn valid expressions into character strings.
drake tempfile
Output a random tip about drake.
drake_triggers helper
Remove leading and trailing escaped quotes from character strings.
evaluate
Use wildcard templating to create a workflow plan data frame from a te...
example_drake
Show a file's encoded representation in the cache
Search up the file system for the nearest drake cache.
find_knitr_doc
Search up the file system for the nearest root path of a drake project...
from_plan
Task passed to individual futures in the "future" backend
gather
Gather multiple groupings of targets
The default cache of a drake project.
Deprecated, get a trace of a dynamic target's value.
Name of the current target
Ignore code
List all the imports in the drake cache.
List the targets in progress
is_function_call
Isolate the side effects of an example.
Load the mtcars example.
drake now has just one hash algorithm per cache.
Run your project (build the outdated targets).
Internal function with a drake_config() argument
Just process the imports
Just make the targets
Apply make() with a pre-computed config object
Default Makefile recipe
Manage the in-memory dependencies of a target.
Create a plan that maps a function to a grid of arguments.
max_useful_jobs
migrate_drake_project
Make a new drake cache.
drake_deps constructor
drake_deps_ht constructor
drake_settings constructor
drake_triggers constructor
Suppress dependency detection.
List the targets that are out of date.
Internal function with a drake_config() argument
parallel_stages
Specialized wildcard for summaries
Turn a drake plan into a plain R script file.
Turn a drake plan into an R notebook.
plot_graph
Predict parallel computing behavior
Read a config object from the cache
Read a workflow graph from the cache
Predict the elapsed runtime of the next call to make()for non-staged...
Internal function with a drake_config() argument
Predict the load balancing of the next call to make()for non-staged ...
Internal function with a drake_config() argument
Process an imported data object
Get the build progress of your targets
Prune the graph
Launch a drake function in a fresh new R process
Default Makefile recipe wildcard
rate_limiting_times
Read the pseudo-random number generator seed of the project.
read_graph
read_plan
Read a trace of a dynamic target.
Read and return a drake target/import from the cache.
Load or create a drake cache
List the most upstream recoverable outdated targets.
Internal function with a drake_config() argument
Reduce multiple groupings of targets
Write commands to reduce several targets down to one.
Objects exported from other packages
Visualize the workflow with ggplot2/ggraph using `drake_graph_info...
Render a visualization using the data frames generated by `drake_graph...
render_graph
Show how a target/import was produced.
Deprecated: show a ggraph/ggplot2 representation of your drake pro...
Render a Sankey diagram from drake_graph_info().
Deprecated: render a ggraph/ggplot2 representation of your drake p...
Show a workflow graph as text in your terminal window using `drake_gra...
Try to repair a drake cache that is prone to throwing storr-related ...
Loadd target at cursor into global environment
RStudio addin for r_make()
RStudio addin for r_outdated()
List sub-targets
summaries
Customize a target in drake_plan().
Storr namespaces for targets
Show a workflow graph as text in your terminal window.
Internal function with a drake_config() argument
Get the cache at the exact file path specified.
List the targets and imports that are reproducibly tracked.
Transform a plan
Transformations in drake_plan().
Customize the decision rules for rebuilding targets
List the old drake triggers.
Use drake in a project
Show an interactive visual network representation of your drake projec...
Internal function with a drake_config() argument
Static code analysis
Which targets will clean() invalidate?
workflow
workplan
A general-purpose computational engine for data analysis, drake rebuilds intermediate data objects when their dependencies change, and it skips work when the results are already up to date. Not every execution starts from scratch, there is native support for parallel and distributed computing, and completed projects have tangible evidence that they are reproducible. Extensive documentation, from beginner-friendly tutorials to practical examples and more, is available at the reference website <https://docs.ropensci.org/drake/> and the online manual <https://books.ropensci.org/drake/>.
Useful links