A Pipeline Toolkit for Reproducible Computation at Scale


[Up] [Top]

Documentation for package ‘drake’ version 7.2.0

Help Pages

drake-package drake: A pipeline toolkit for reproducible computation at scale.
bind_plans Row-bind together drake plans
build_times List the time it took to build each target.
cached List targets in the cache.
clean Remove targets/imports from the cache.
clean_mtcars_example Clean the mtcars example from 'drake_example("mtcars")'
code_to_plan Turn an R script file or knitr / R Markdown report into a 'drake' workflow plan data frame.
deps_code List the dependencies of a function or command
deps_knitr Find the drake dependencies of a dynamic knitr report target.
deps_profile Find out why a target is out of date.
deps_target List the dependencies of a target
diagnose Get diagnostic metadata on a target.
drake drake: A pipeline toolkit for reproducible computation at scale.
drake_build Build/process a single target or import.
drake_cache_log Get a table that represents the state of the cache.
drake_config Create the internal runtime parameter list used internally in 'make()'.
drake_debug Run a single target's command in debug mode.
drake_envir Get the environment where drake builds targets
drake_example Download and save the code and data files of an example 'drake'-powered project.
drake_examples List the names of all the drake examples.
drake_gc Do garbage collection on the drake cache.
drake_get_session_info Return the 'sessionInfo()' of the last call to 'make()'.
drake_ggraph Show a 'ggraph'/'ggplot2' representation of your drake project.
drake_graph_info Create the underlying node and edge data frames behind 'vis_drake_graph()'.
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.
drake_plan Create a workflow plan data frame for the 'plan' argument of 'make()'.
drake_plan_source Show the code required to produce a given workflow plan data frame
evaluate_plan Use wildcard templating to create a workflow plan data frame from a template data frame.
expand_plan Create replicates of targets.
expose_imports Expose all the imports in a package so 'make()' can detect all the package's nested functions.
failed List failed targets. to 'make()'.
file_in Declare input files and directories.
file_out Declare output files and directories.
file_store Tell 'drake' that you want information on a _file_ (target or import), not an ordinary object.
find_cache Search up the file system for the nearest drake cache.
gather_by Gather multiple groupings of targets
gather_plan Write commands to combine several targets into one or more overarching targets.
get_cache Get the default cache of a 'drake' project.
ignore Ignore components of commands and imported functions.
knitr_in Declare 'knitr'/'rmarkdown' source files as dependencies.
legend_nodes Create the nodes data frame used in the legend of the graph visualizations.
loadd Read and return a drake target/import from the cache.
load_mtcars_example Load the mtcars example.
make Run your project (build the outdated targets).
map_plan Create a plan that maps a function to a grid of arguments.
missed Report any import objects required by your drake_plan plan but missing from your workspace or file system.
new_cache Make a new 'drake' cache.
outdated List the targets that are out of date.
plan_to_code Turn a 'drake' workflow plan data frame into a plain R script file.
plan_to_notebook Turn a 'drake' workflow plan data frame into an R notebook,
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.
progress Get the build progress of your targets during a 'make()'.
readd Read and return a drake target/import from the cache.
read_drake_seed Read the pseudo-random number generator seed of the project.
reduce_by Reduce multiple groupings of targets
reduce_plan Write commands to reduce several targets down to one.
render_drake_ggraph Render a static 'ggplot2'/'ggraph' visualization from 'drake_graph_info()' output.
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()'.
rescue_cache Try to repair a drake cache that is prone to throwing 'storr'-related errors.
running List running targets.
r_drake_build Experimental: reproducible R session management for drake functions
r_drake_ggraph Experimental: reproducible R session management for drake functions
r_drake_graph_info Experimental: reproducible R session management for drake functions
r_make Experimental: reproducible R session management for drake functions
r_missed Experimental: reproducible R session management for drake functions
r_outdated Experimental: reproducible R session management for drake functions
r_predict_runtime Experimental: reproducible R session management for drake functions
r_predict_workers Experimental: reproducible R session management for drake functions
r_sankey_drake_graph Experimental: reproducible R session management for drake functions
r_vis_drake_graph Experimental: reproducible R session management for drake functions
sankey_drake_graph Show a Sankey graph of your drake project.
show_source Show how a target/import was produced.
tracked List the targets and imports that are reproducibly tracked.
trigger Customize the decision rules for rebuilding targets
use_drake Use drake in a project
vis_drake_graph Show an interactive visual network representation of your drake project.