Skip to contents

Help

drake-package
drake: A pipeline toolkit for reproducible computation at scale.

Examples

use_drake()
Use drake in a project [Questioning]
drake_example()
Download the files of an example drake project. [Stable]
drake_examples()
List the names of all the drake examples. [Stable]
load_mtcars_example()
Load the mtcars example. [Stable]
clean_mtcars_example()
Clean the mtcars example from drake_example("mtcars") [Stable]

Build and configure

make()
Run your project (build the outdated targets). [Stable]
drake_config()
Ending of _drake.R for r_make() and friends [Stable]
drake_build()
Build/process a single target or import. [Questioning]

drake plans and helpers

drake_plan()
Create a drake plan for the plan argument of make(). [Stable]
transform_plan()
Transform a plan [Stable]
drake_plan_source()
Show the code required to produce a given drake plan [Stable]
code_to_function()
Turn a script into a function. [Stable]
code_to_plan()
Turn an R script file or knitr / R Markdown report into a drake plan. [Questioning]
plan_to_code()
Turn a drake plan into a plain R script file. [Questioning]
plan_to_notebook()
Turn a drake plan into an R notebook. [Questioning]
bind_plans()
Row-bind together drake plans [Stable]
drake_slice()
Take a strategic subset of a dataset. [Stable]

drake plan keywords

target()
Customize a target in drake_plan(). [Stable]
trigger()
Customize the decision rules for rebuilding targets [Stable]
file_in()
Declare input files and directories. [Stable]
file_out()
Declare output files and directories. [Stable]
knitr_in()
Declare knitr/rmarkdown source files as dependencies. [Stable]
cancel()
Cancel a target mid-build [Stable]
cancel_if()
Cancel a target mid-build under some condition [Stable])`
ignore()
Ignore code [Stable]
no_deps()
Suppress dependency detection. [Stable]
id_chr()
Name of the current target [Stable]
drake_envir()
Get the environment where drake builds targets [Questioning]

Transformations

transformations
Transformations in drake_plan(). [Stable]

Dynamic branching

subtargets()
List sub-targets [Stable]
read_trace()
Read a trace of a dynamic target. [Stable]

Reproducible R session management

Network graphs and visualization

vis_drake_graph()
Show an interactive visual network representation of your drake project. [Stable]
sankey_drake_graph()
Show a Sankey graph of your drake project. [Stable]
drake_ggraph()
Visualize the workflow with ggraph/ggplot2 [Stable]
text_drake_graph()
Show a workflow graph as text in your terminal window. [Stable]
render_drake_graph()
Render a visualization using the data frames generated by drake_graph_info(). [Stable]
render_sankey_drake_graph()
Render a Sankey diagram from drake_graph_info(). [Stable]
render_drake_ggraph()
Visualize the workflow with ggplot2/ggraph using drake_graph_info() output. [Stable]
render_text_drake_graph()
Show a workflow graph as text in your terminal window using drake_graph_info() output. [Stable]
drake_graph_info()
Prepare the workflow graph for visualization [Stable]
legend_nodes()
Create the nodes data frame used in the legend of the graph visualizations. [Soft-deprecated]

Target status

drake_history()
History and provenance [Stable]
outdated()
List the targets that are out of date. [Stable]
recoverable()
List the most upstream recoverable outdated targets. [Stable]
missed()
Report any import objects required by your drake_plan plan but missing from your workspace or file system. [Stable]
tracked()
List the targets and imports that are reproducibly tracked. [Stable]
deps_code()
List the dependencies of a function or command [Stable]
deps_target()
List the dependencies of a target [Stable]
deps_knitr()
Find the drake dependencies of a dynamic knitr report target. [Stable]
deps_profile()
Find out why a target is out of date. [Stable]

Debugging and testing

diagnose()
Get diagnostic metadata on a target. [Stable]
drake_debug()
Run a single target's command in debug mode.' [Questioning]

High-performance computing

drake_hpc_template_file()
Write a template file for deploying work to a cluster / job scheduler. [Stable]
drake_hpc_template_files()
List the available example template files for deploying work to a cluster / job scheduler. [Stable]

Time

build_times()
See the time it took to build each target. [Stable]
predict_runtime()
Predict the elapsed runtime of the next call to make() for non-staged parallel backends. [Stable]
predict_workers()
Predict the load balancing of the next call to make() for non-staged parallel backends. [Stable]

Cache creation

drake_cache()
Get the cache of a drake project. [Stable]
new_cache()
Make a new drake cache. `[Stable]
find_cache()
Search up the file system for the nearest drake cache. [Stable]

Cache usage

readd() loadd()
Read and return a drake target/import from the cache. [Stable]
cached()
List targets in the cache. [Stable]
cached_planned()
List targets in both the plan and the cache. [Stable]
cached_unplanned()
List targets in the cache but not the plan. [Stable]
drake_cache_log()
Get the state of the cache. [Stable]
drake_get_session_info()
Session info of the last call to make(). [Stable]
read_drake_seed()
Read the pseudo-random number generator seed of the project. [Stable]
show_source()
Show how a target/import was produced. [Stable]
file_store()
Show a file's encoded representation in the cache [Stable]
drake_tempfile()
drake tempfile [Stable]

Cache maintenance

clean()
Invalidate and deregister targets. [Stable]
which_clean()
Which targets will clean() invalidate? [Stable]
drake_gc()
Do garbage collection on the drake cache. [Stable]
rescue_cache()
Try to repair a drake cache that is prone to throwing storr-related errors. [Questioning]

Progress

drake_progress()
Get the build progress of your targets [Stable]
drake_running()
List running targets. [Stable]
drake_done()
List done targets. [Stable]
drake_failed()
List failed targets. [Stable]
drake_cancelled()
List cancelled targets. [Stable]