Help

drake-package

drake: A pipeline toolkit for reproducible computation at scale.

Examples

use_drake()

Use drake in a project Questioning lifecycle

drake_example()

Download the files of an example drake project. Maturing lifecycle

drake_examples()

List the names of all the drake examples. Stable lifecycle

load_mtcars_example()

Load the mtcars example. Maturing lifecycle

clean_mtcars_example()

Clean the mtcars example from drake_example("mtcars") Stable lifecycle

Build and configure

make()

Run your project (build the outdated targets). Maturing lifecycle

drake_config()

Interpret the plan and prepare for make() Maturing lifecycle

drake_build()

Build/process a single target or import. Maturing lifecycle

drake plans and helpers

drake_plan()

Create a workflow plan data frame for the plan argument of make(). Maturing lifecycle

transform_plan()

Transform a plan Maturing lifecycle

drake_plan_source()

Show the code required to produce a given drake plan Stable lifecycle

code_to_plan()

Turn an R script file or knitr / R Markdown report into a drake plan. Stable lifecycle

plan_to_code()

Turn a drake plan into a plain R script file. Stable lifecycle

plan_to_notebook()

Turn a drake plan into an R notebook. Stable lifecycle

bind_plans()

Row-bind together drake plans Stable lifecycle

drake_slice()

Take a strategic subset of a dataset. Maturing lifecycle

drake plan keywords

target()

Customize a target in drake_plan(). Maturing lifecycle

trigger()

Customize the decision rules for rebuilding targets Stable lifecycle

map()

Define multiple targets at once Maturing lifecycle

split()

Define a target for each subset of data Maturing lifecycle

cross()

Define a target for each combination of values Maturing lifecycle

combine()

Define aggregates of other targets Maturing lifecycle

file_in()

Declare input files and directories. Stable lifecycle

file_out()

Declare output files and directories. Stable lifecycle

knitr_in()

Declare knitr/rmarkdown source files as dependencies. Stable lifecycle

ignore()

Ignore code Stable lifecycle

no_deps()

Suppress dependency detection. Stable lifecycle

drake_envir()

Get the environment where drake builds targets Questioning lifecycle

Reproducible R session management

r_make() r_drake_build() r_outdated() r_recoverable() r_missed() r_deps_target() r_drake_graph_info() r_vis_drake_graph() r_sankey_drake_graph() r_drake_ggraph() r_text_drake_graph() r_predict_runtime() r_predict_workers()

Launch a drake function in a fresh new R process Maturing lifecycle

Network graphs and visualization

vis_drake_graph()

Show an interactive visual network representation of your drake project. Maturing lifecycle

sankey_drake_graph()

Show a Sankey graph of your drake project. Stable lifecycle

drake_ggraph()

Visualize the workflow with ggraph/ggplot2 Stable lifecycle

text_drake_graph()

Show a workflow graph as text in your terminal window. Stable lifecycle

render_drake_graph()

Render a visualization using the data frames generated by drake_graph_info(). Maturing lifecycle

render_sankey_drake_graph()

Render a Sankey diagram from drake_graph_info(). Stable lifecycle

render_drake_ggraph()

Visualize the workflow with ggplot2/ggraph using drake_graph_info() output. Stable lifecycle

render_text_drake_graph()

Show a workflow graph as text in your terminal window using drake_graph_info() output. Stable lifecycle

drake_graph_info()

Prepare the workflow graph for visualization Stable lifecycle

legend_nodes()

Create the nodes data frame used in the legend of the graph visualizations. Soft-deprecated lifecycle

Target status

drake_history()

History and provenance Experimental lifecycle

outdated()

List the targets that are out of date. Stable lifecycle

recoverable()

List the most upstream recoverable outdated targets. Experimental lifecycle

missed()

Report any import objects required by your drake_plan plan but missing from your workspace or file system. Stable lifecycle

tracked()

List the targets and imports that are reproducibly tracked. Stable lifecycle

deps_code()

List the dependencies of a function or command Stable lifecycle

deps_target()

List the dependencies of a target Stable lifecycle

deps_knitr()

Find the drake dependencies of a dynamic knitr report target. Stable lifecycle

deps_profile()

Find out why a target is out of date. Stable lifecycle

Debugging and testing

diagnose()

Get diagnostic metadata on a target. Maturing lifecycle

drake_debug()

Run a single target's command in debug mode.' Maturing lifecycle

High-performance computing

drake_hpc_template_file()

Write a template file for deploying work to a cluster / job scheduler. Stable lifecycle

drake_hpc_template_files()

List the available example template files for deploying work to a cluster / job scheduler. Stable lifecycle

Time

build_times()

See the time it took to build each target. Maturing lifecycle

predict_runtime()

Predict the elapsed runtime of the next call to make() for non-staged parallel backends. Maturing lifecycle

predict_workers()

Predict the load balancing of the next call to make() for non-staged parallel backends. Maturing lifecycle

Caches

drake_cache()

Get the cache of a drake project. Stable lifecycle

new_cache()

Make a new drake cache. Maturing lifecycle

find_cache()

Search up the file system for the nearest drake cache. Stable lifecycle

Cache inspection

readd() loadd()

Read and return a drake target/import from the cache. Maturing lifecycle

cached()

List targets in the cache. Maturing lifecycle

drake_cache_log()

Get the state of the cache. Maturing lifecycle

drake_get_session_info()

Session info of the last call to make(). Maturing lifecycle

read_drake_seed()

Read the pseudo-random number generator seed of the project. Maturing lifecycle

show_source()

Show how a target/import was produced. Stable lifecycle

file_store()

Show a file's encoded representation in the cache Stable lifecycle

Cache maintenance

clean()

Invalidate and deregister targets. Maturing lifecycle

drake_gc()

Do garbage collection on the drake cache. Maturing lifecycle

rescue_cache()

Try to repair a drake cache that is prone to throwing storr-related errors. Questioning lifecycle

Progress

progress()

Get the build progress of your targets Maturing lifecycle

running()

List running targets. Maturing lifecycle

failed()

List failed targets. Maturing lifecycle

R packages as drake workflows

expose_imports()

Expose all the objects in a package so make() can detect them as imported dependencies. Stable lifecycle