Function reference • rOpenSci: drake

Help
`drake-package`	drake: A pipeline toolkit for reproducible computation at scale.
Examples
`use_drake()`	Use drake in a project
`drake_example()`	Download the files of an example `drake` project.
`drake_examples()`	List the names of all the drake examples.
`load_mtcars_example()`	Load the mtcars example.
`clean_mtcars_example()`	Clean the mtcars example from `drake_example("mtcars")`
Build and configure
`make()`	Run your project (build the outdated targets).
`drake_config()`	Ending of _drake.R for r_make() and friends
`drake_build()`	Build/process a single target or import.
drake plans and helpers
`drake_plan()`	Create a drake plan for the `plan` argument of `make()`.
`transform_plan()`	Transform a plan
`drake_plan_source()`	Show the code required to produce a given `drake` plan
`code_to_function()`	Turn a script into a function.
`code_to_plan()`	Turn an R script file or `knitr` / R Markdown report into a `drake` plan.
`plan_to_code()`	Turn a `drake` plan into a plain R script file.
`plan_to_notebook()`	Turn a `drake` plan into an R notebook.
`bind_plans()`	Row-bind together drake plans
`drake_slice()`	Take a strategic subset of a dataset.
drake plan keywords
`target()`	Customize a target in `drake_plan()`.
`trigger()`	Customize the decision rules for rebuilding targets
`file_in()`	Declare input files and directories.
`file_out()`	Declare output files and directories.
`knitr_in()`	Declare `knitr`/`rmarkdown` source files as dependencies.
`cancel()`	Cancel a target mid-build
`cancel_if()`	Cancel a target mid-build under some condition )`
`ignore()`	Ignore code
`no_deps()`	Suppress dependency detection.
`id_chr()`	Name of the current target
`drake_envir()`	Get the environment where drake builds targets
Transformations
`transformations`	Transformations in `drake_plan()`.
Dynamic branching
`subtargets()`	List sub-targets
`read_trace()`	Read a trace of a dynamic target.
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
Network graphs and visualization
`vis_drake_graph()`	Show an interactive visual network representation of your drake project.
`sankey_drake_graph()`	Show a Sankey graph of your drake project.
`drake_ggraph()`	Visualize the workflow with `ggraph`/`ggplot2`
`text_drake_graph()`	Show a workflow graph as text in your terminal window.
`render_drake_graph()`	Render a visualization using the data frames generated by `drake_graph_info()`.
`render_sankey_drake_graph()`	Render a Sankey diagram from `drake_graph_info()`.
`render_drake_ggraph()`	Visualize the workflow with `ggplot2`/`ggraph` using `drake_graph_info()` output.
`render_text_drake_graph()`	Show a workflow graph as text in your terminal window using `drake_graph_info()` output.
`drake_graph_info()`	Prepare the workflow graph for visualization
`legend_nodes()`	Create the nodes data frame used in the legend of the graph visualizations.
Target status
`drake_history()`	History and provenance
`outdated()`	List the targets that are out of date.
`recoverable()`	List the most upstream recoverable outdated targets.
`missed()`	Report any import objects required by your drake_plan plan but missing from your workspace or file system.
`tracked()`	List the targets and imports that are reproducibly tracked.
`deps_code()`	List the dependencies of a function or command
`deps_target()`	List the dependencies of a target
`deps_knitr()`	Find the drake dependencies of a dynamic knitr report target.
`deps_profile()`	Find out why a target is out of date.
Debugging and testing
`diagnose()`	Get diagnostic metadata on a target.
`drake_debug()`	Run a single target's command in debug mode.'
High-performance computing
`drake_hpc_template_file()`	Write a template file for deploying work to a cluster / job scheduler.
`drake_hpc_template_files()`	List the available example template files for deploying work to a cluster / job scheduler.
Time
`build_times()`	See the time it took to build each target.
`predict_runtime()`	Predict the elapsed runtime of the next call to `make()` for non-staged parallel backends.
`predict_workers()`	Predict the load balancing of the next call to `make()` for non-staged parallel backends.
Cache creation
`drake_cache()`	Get the cache of a `drake` project.
`new_cache()`	Make a new `drake` cache. `
`find_cache()`	Search up the file system for the nearest drake cache.
Cache usage
`readd()` `loadd()`	Read and return a drake target/import from the cache.
`cached()`	List targets in the cache.
`cached_planned()`	List targets in both the plan and the cache.
`cached_unplanned()`	List targets in the cache but not the plan.
`drake_cache_log()`	Get the state of the cache.
`drake_get_session_info()`	Session info of the last call to `make()`.
`read_drake_seed()`	Read the pseudo-random number generator seed of the project.
`show_source()`	Show how a target/import was produced.
`file_store()`	Show a file's encoded representation in the cache
`drake_tempfile()`	drake tempfile
Cache maintenance
`clean()`	Invalidate and deregister targets.
`which_clean()`	Which targets will `clean()` invalidate?
`drake_gc()`	Do garbage collection on the drake cache.
`rescue_cache()`	Try to repair a drake cache that is prone to throwing `storr`-related errors.
Progress
`drake_progress()`	Get the build progress of your targets
`drake_running()`	List running targets.
`drake_done()`	List done targets.
`drake_failed()`	List failed targets.
`drake_cancelled()`	List cancelled targets.

Reference

Help

Examples

Build and configure

drake plans and helpers

drake plan keywords

Transformations

Dynamic branching

Reproducible R session management

Network graphs and visualization

Target status

Debugging and testing

High-performance computing

Time

Cache creation

Cache usage

Cache maintenance

Progress

About

Community

Resources