A Pipeline Toolkit for Reproducible Computation at Scale

Documentation for package ‘drake’ version 7.12.4

DESCRIPTION file.

Help Pages

B C D F G I K L M N O P R S T U V W

drake-package

drake: A pipeline toolkit for reproducible computation at scale.

-- B --

bind_plans	Row-bind together drake plans \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
build_times	See the time it took to build each target. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- C --

cached	List targets in the cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
cached_planned	List targets in both the plan and the cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
cached_unplanned	List targets in the cache but not the plan. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
cancel	Cancel a target mid-build \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
cancel_if	Cancel a target mid-build under some condition \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
clean	Invalidate and deregister targets. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
clean_mtcars_example	Clean the mtcars example from 'drake_example("mtcars")' \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
code_to_function	Turn a script into a function. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
code_to_plan	Turn an R script file or 'knitr' / R Markdown report into a 'drake' plan. \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
combine	Transformations in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
cross	Transformations in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- D --

deps_code	List the dependencies of a function or command \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
deps_knitr	Find the drake dependencies of a dynamic knitr report target. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
deps_profile	Find out why a target is out of date. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
deps_target	List the dependencies of a target \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
diagnose	Get diagnostic metadata on a target. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake	drake: A pipeline toolkit for reproducible computation at scale.
drake_build	Build/process a single target or import. \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
drake_cache	Get the cache of a 'drake' project. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_cache_log	Get the state of the cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_cancelled	List cancelled targets. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_config	Ending of _drake.R for r_make() and friends \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_debug	Run a single target's command in debug mode.' \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
drake_done	List done targets. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_envir	Get the environment where drake builds targets \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
drake_example	Download the files of an example 'drake' project. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_examples	List the names of all the drake examples. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_failed	List failed targets. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_gc	Do garbage collection on the drake cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_get_session_info	Session info of the last call to 'make()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_ggraph	Visualize the workflow with 'ggraph'/'ggplot2' \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_graph_info	Prepare the workflow graph for visualization \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_history	History and provenance \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_hpc_template_file	Write a template file for deploying work to a cluster / job scheduler. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_hpc_template_files	List the available example template files for deploying work to a cluster / job scheduler. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_plan	Create a drake plan for the 'plan' argument of 'make()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_plan_source	Show the code required to produce a given 'drake' plan \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_progress	Get the build progress of your targets \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_running	List running targets. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_script	Write an example _drake.R script to the current working directory.
drake_slice	Take a strategic subset of a dataset. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
drake_tempfile	drake tempfile \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- F --

file_in	Declare input files and directories. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
file_out	Declare output files and directories. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
file_store	Show a file's encoded representation in the cache \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
find_cache	Search up the file system for the nearest drake cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- G --

group

Transformations in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- I --

id_chr	Name of the current target \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
ignore	Ignore code \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- K --

knitr_in

Declare 'knitr'/'rmarkdown' source files as dependencies. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- L --

legend_nodes	Create the nodes data frame used in the legend of the graph visualizations. \Sexpr[results=rd, stage=render]{drake:::lifecycle("soft-deprecated")}
loadd	Read and return a drake target/import from the cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
load_mtcars_example	Load the mtcars example. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- M --

make	Run your project (build the outdated targets). \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
map	Transformations in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
missed	Report any import objects required by your drake_plan plan but missing from your workspace or file system. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- N --

new_cache	Make a new 'drake' cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
no_deps	Suppress dependency detection. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- O --

outdated

List the targets that are out of date. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- P --

plan_to_code	Turn a 'drake' plan into a plain R script file. \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
plan_to_notebook	Turn a 'drake' plan into an R notebook. \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
predict_runtime	Predict the elapsed runtime of the next call to 'make()' for non-staged parallel backends. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
predict_workers	Predict the load balancing of the next call to 'make()' for non-staged parallel backends. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- R --

readd	Read and return a drake target/import from the cache. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
read_drake_seed	Read the pseudo-random number generator seed of the project. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
read_trace	Read a trace of a dynamic target. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
recoverable	List the most upstream _recoverable_ outdated targets. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
render_drake_ggraph	Visualize the workflow with 'ggplot2'/'ggraph' using 'drake_graph_info()' output. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
render_drake_graph	Render a visualization using the data frames generated by 'drake_graph_info()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
render_sankey_drake_graph	Render a Sankey diagram from 'drake_graph_info()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
render_text_drake_graph	Show a workflow graph as text in your terminal window using 'drake_graph_info()' output. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
rescue_cache	Try to repair a drake cache that is prone to throwing 'storr'-related errors. \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}
r_deps_target	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_drake_build	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_drake_ggraph	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_drake_graph_info	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_make	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_missed	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_outdated	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_predict_runtime	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_predict_workers	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_recoverable	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_sankey_drake_graph	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_text_drake_graph	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
r_vis_drake_graph	Launch a drake function in a fresh new R process \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- S --

sankey_drake_graph	Show a Sankey graph of your drake project. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
show_source	Show how a target/import was produced. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
split	Transformations in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
subtargets	List sub-targets \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- T --

target	Customize a target in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
text_drake_graph	Show a workflow graph as text in your terminal window. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
tracked	List the targets and imports that are reproducibly tracked. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
transformations	Transformations in 'drake_plan()'. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
transform_plan	Transform a plan \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}
trigger	Customize the decision rules for rebuilding targets \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- U --

use_drake

Use drake in a project \Sexpr[results=rd, stage=render]{drake:::lifecycle("questioning")}

-- V --

vis_drake_graph

Show an interactive visual network representation of your drake project. \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}

-- W --

which_clean

Which targets will 'clean()' invalidate? \Sexpr[results=rd, stage=render]{drake:::lifecycle("stable")}