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. Stable lifecycle

drake_examples()

List the names of all the drake examples. Stable lifecycle

load_mtcars_example()

Load the mtcars example. Stable 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). Stable lifecycle

drake_config()

Ending of _drake.R for r_make() and friends Stable lifecycle

drake_build()

Build/process a single target or import. Questioning lifecycle

drake plans and helpers

drake_plan()

Create a drake plan for the plan argument of make(). Stable lifecycle

transform_plan()

Transform a plan Stable lifecycle

drake_plan_source()

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

code_to_function()

Turn a script into a function. Stable lifecycle

code_to_plan()

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

plan_to_code()

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

plan_to_notebook()

Turn a drake plan into an R notebook. Questioning lifecycle

bind_plans()

Row-bind together drake plans Stable lifecycle

drake_slice()

Take a strategic subset of a dataset. Stable lifecycle

drake plan keywords

target()

Customize a target in drake_plan(). Stable lifecycle

trigger()

Customize the decision rules for rebuilding targets Stable 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

cancel()

Cancel a target mid-build Stable lifecycle

cancel_if()

Cancel a target mid-build under some condition Stable lifecycle)`

ignore()

Ignore code Stable lifecycle

no_deps()

Suppress dependency detection. Stable lifecycle

id_chr()

Name of the current target Stable lifecycle

drake_envir()

Get the environment where drake builds targets Questioning lifecycle

Transformations

transformations

Transformations in drake_plan(). Stable lifecycle

Dynamic branching

subtargets()

List sub-targets Stable lifecycle

read_trace()

Read a trace of a dynamic target. Stable lifecycle

Reproducible R session management

drake_script()

Write an example _drake.R script to the current working directory.

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 Stable lifecycle

Network graphs and visualization

vis_drake_graph()

Show an interactive visual network representation of your drake project. Stable 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(). Stable 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 Stable lifecycle

outdated()

List the targets that are out of date. Stable lifecycle

recoverable()

List the most upstream recoverable outdated targets. Stable 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. Stable lifecycle

drake_debug()

Run a single target's command in debug mode.' Questioning 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. Stable lifecycle

predict_runtime()

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

predict_workers()

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

Cache creation

drake_cache()

Get the cache of a drake project. Stable lifecycle

new_cache()

Make a new drake cache. `Stable lifecycle

find_cache()

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

Cache usage

readd() loadd()

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

cached()

List targets in the cache. Stable lifecycle

cached_planned()

List targets in both the plan and the cache. Stable lifecycle

cached_unplanned()

List targets in the cache but not the plan. Stable lifecycle

drake_cache_log()

Get the state of the cache. Stable lifecycle

drake_get_session_info()

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

read_drake_seed()

Read the pseudo-random number generator seed of the project. Stable 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

drake_tempfile()

drake tempfile Stable lifecycle

Cache maintenance

clean()

Invalidate and deregister targets. Stable lifecycle

which_clean()

Which targets will clean() invalidate? Stable lifecycle

drake_gc()

Do garbage collection on the drake cache. Stable lifecycle

rescue_cache()

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

Progress

drake_progress()

Get the build progress of your targets Stable lifecycle

drake_running()

List running targets. Stable lifecycle

drake_done()

List done targets. Stable lifecycle

drake_failed()

List failed targets. Stable lifecycle

drake_cancelled()

List cancelled targets. Stable lifecycle