drake7.13.11 package

A Pipeline Toolkit for Reproducible Computation at Scale

analyses

analyses

analysis_wildcard

Show the analysis wildcard used in plan_summaries().

as_drake_filename

as_drake_filename

as_file

as_file

available_hash_algos

List the available hash algorithms for drake caches.

backend

backend

bind_plans

Row-bind together drake plans

build_drake_graph

Function build_drake_graph

build_graph

build_graph

build_times

See the time it took to build each target.

built

List all the built targets (non-imports) in the cache.

cache_namespaces

List all the storr cache namespaces used by drake.

cache_path

Return the file path where the cache is stored, if applicable.

cached_planned

List targets in both the plan and the cache.

cached_unplanned

List targets in the cache but not the plan.

cached

List targets in the cache.

cancel_if

Cancel a target mid-build under some condition

cancel

Cancel a target mid-build

check_plan

Check a workflow plan data frame for obvious errors.

check

check

clean_main_example

Deprecated: clean the main example from drake_example("main")

clean_mtcars_example

Clean the mtcars example from drake_example("mtcars")

clean

Invalidate and deregister targets.

cleaned_namespaces

Auxiliary storr namespaces

cmq_build

Build a target using the clustermq backend

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 pl...

config

config

configure_cache

Configure the hash algorithms, etc. of a drake cache.

dataframes_graph

dataframes_graph

dataset_wildcard

Show the dataset wildcard used in plan_analyses() and `plan_summarie...

debug_and_run

Run a function in debug mode.

default_graph_title

Return the default title for graph visualizations

default_long_hash_algo

Return the default long hash algorithm for make().

default_Makefile_args

Default arguments of Makefile parallelism

default_Makefile_command

Default Makefile command

default_parallelism

Default parallel backend

default_recipe_command

Default Makefile recipe command

default_short_hash_algo

Return the default short hash algorithm for make().

default_system2_args

default_system2_args

default_verbose

Default verbosity

dependency_profile

States of the dependencies of a target

deprecate_wildcard

deprecate_wildcard

deps_code

List the dependencies of a function or command

deps_knitr

Find the drake dependencies of a dynamic knitr report target.

deps_profile_impl

Internal function with a drake_config() argument

deps_profile

Find out why a target is out of date.

deps_target_impl

Internal function with a drake_config() argument

deps_target

List the dependencies of a target

deps_targets

See the dependencies of a target

deps

deps

diagnose

Get diagnostic metadata on a target.

do_prework

Do the prework in the preworkargument to make().

doc_of_function_call

doc_of_function_call

drake_batchtools_tmpl_file

Get a template file for execution on a cluster.

drake_build_impl

Internal function with a drake_config() argument

drake_build

Build/process a single target or import.

drake_cache_log_file

Generate a flat text log file to represent the state of the cache.

drake_cache_log

Get the state of the cache.

drake_cache

Get the cache of a drake project.

drake_cancelled

List cancelled targets.

drake_config

Ending of _drake.R for r_make() and friends

drake_debug

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

drake_deps_ht

drake_deps_ht helper

drake_deps

drake_deps helper

drake_done

List done targets.

drake_envir

Get the environment where drake builds targets

drake_example

Download the files of an example drake project.

drake_examples

List the names of all the drake examples.

drake_failed

List failed targets.

drake_gc

Do garbage collection on the drake cache.

drake_get_session_info

Session info of the last call to make().

drake_ggraph_impl

Internal function with a drake_config() argument

drake_ggraph

Visualize the workflow with ggraph/ggplot2

drake_graph_info_impl

Internal function

drake_graph_info

Prepare the workflow graph for visualization

drake_history

History and provenance

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 clus...

drake_meta

Compute the initial pre-build metadata of a target or import.

drake_palette

Show drake's color palette.

drake_plan_source

Show the code required to produce a given drake plan

drake_plan

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

drake_progress

Get the build progress of your targets

drake_quotes

Put quotes around each element of a character vector.

drake_running

List running targets.

drake_script

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

drake_session

Session info of the last call to make().

drake_settings

drake_settings helper

drake_slice

Take a strategic subset of a dataset.

drake_strings

Turn valid expressions into character strings.

drake_tempfile

drake tempfile

drake_tip

Output a random tip about drake.

drake_triggers

drake_triggers helper

drake_unquote

Remove leading and trailing escaped quotes from character strings.

drake-package

drake: A pipeline toolkit for reproducible computation at scale.

evaluate_plan

Use wildcard templating to create a workflow plan data frame from a te...

evaluate

evaluate

example_drake

example_drake

examples_drake

examples_drake

expand_plan

Deprecated: create replicates of targets.

expand

expand

expose_imports

Deprecated: expose package functions and objects for analysis with dra...

failed

List failed targets.

file_in

Declare input files and directories.

file_out

Declare output files and directories.

file_store

Show a file's encoded representation in the cache

find_cache

Search up the file system for the nearest drake cache.

find_knitr_doc

find_knitr_doc

find_project

Search up the file system for the nearest root path of a drake project...

from_plan

from_plan

future_build

Task passed to individual futures in the "future" backend

gather_by

Gather multiple groupings of targets

gather_plan

Combine targets

gather

gather

get_cache

The default cache of a drake project.

get_trace

Deprecated, get a trace of a dynamic target's value.

id_chr

Name of the current target

ignore

Ignore code

imported

List all the imports in the drake cache.

in_progress

List the targets in progress

is_function_call

is_function_call

isolate_example

Isolate the side effects of an example.

knitr_deps

Dependencies of a knitr report

knitr_in

Declare knitr/rmarkdown source files as dependencies.

legend_nodes

Create the nodes data frame used in the legend of the graph visualizat...

load_basic_example

load_basic_example

load_main_example

Load the main example.

load_mtcars_example

Load the mtcars example.

long_hash

drake now has just one hash algorithm per cache.

make_impl

Internal function with a drake_config() argument

make_imports

Just process the imports

make_targets

Just make the targets

make_with_config

Apply make() with a pre-computed config object

make

Run your project (build the outdated targets).

Makefile_recipe

Default Makefile recipe

manage_memory

Manage the in-memory dependencies of a target.

map_plan

Create a plan that maps a function to a grid of arguments.

max_useful_jobs

max_useful_jobs

migrate_drake_project

migrate_drake_project

missed_impl

Internal function with a drake_config() argument

missed

Report any import objects required by your drake_plan plan but missing...

new_cache

Make a new drake cache.

new_drake_deps_ht

drake_deps_ht constructor

new_drake_deps

drake_deps constructor

new_drake_settings

drake_settings constructor

new_drake_triggers

drake_triggers constructor

no_deps

Suppress dependency detection.

outdated_impl

Internal function with a drake_config() argument

outdated

List the targets that are out of date.

parallel_stages

parallel_stages

parallelism_choices

Names of old parallel backends

plan_analyses

Specialized wildcard for analyses

plan_drake

plan_drake

plan_summaries

Specialized wildcard for summaries

plan_to_code

Turn a drake plan into a plain R script file.

plan_to_notebook

Turn a drake plan into an R notebook.

plan

plan

plot_graph

plot_graph

predict_load_balancing

Predict parallel computing behavior

predict_runtime_impl

Internal function with a drake_config() argument

predict_runtime

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

predict_workers_impl

Internal function with a drake_config() argument

predict_workers

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

process_import

Process an imported data object

progress

Get the build progress of your targets

prune_drake_graph

Prune the graph

r_make

Launch a drake function in a fresh new R process

r_recipe_wildcard

Default Makefile recipe wildcard

rate_limiting_times

rate_limiting_times

read_config

read_config

read_drake_config

Read a config object from the cache

read_drake_graph

Read a workflow graph from the cache

read_drake_meta

read_drake_meta

read_drake_plan

Read the plan from the cache

read_drake_seed

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

read_graph

read_graph

read_plan

read_plan

read_trace

Read a trace of a dynamic target.

readd

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

recover_cache

Load or create a drake cache

recoverable_impl

Internal function with a drake_config() argument

recoverable

List the most upstream recoverable outdated targets.

reduce_by

Reduce multiple groupings of targets

reduce_plan

Write commands to reduce several targets down to one.

reexports

Objects exported from other packages

render_drake_ggraph

Visualize the workflow with ggplot2/ggraph using `drake_graph_info...

render_drake_graph

Render a visualization using the data frames generated by `drake_graph...

render_graph

render_graph

render_sankey_drake_graph

Render a Sankey diagram from drake_graph_info().

render_static_drake_graph

Deprecated: render a ggraph/ggplot2 representation of your drake p...

render_text_drake_graph

Show a workflow graph as text in your terminal window using `drake_gra...

rescue_cache

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

rs_addin_loadd

Loadd target at cursor into global environment

rs_addin_r_make

RStudio addin for r_make()

rs_addin_r_outdated

RStudio addin for r_outdated()

rs_addin_r_vis_drake_graph

RStudio addin for r_vis_drake_graph()

running

List running targets.

sankey_drake_graph_impl

Internal function with a drake_config() argument

sankey_drake_graph

Show a Sankey graph of your drake project.

session

session

shell_file

Shell file for Makefile parallelism

short_hash

drake now only uses one hash algorithm per cache.

show_source

Show how a target/import was produced.

static_drake_graph

Deprecated: show a ggraph/ggplot2 representation of your drake pro...

subtargets

List sub-targets

summaries

summaries

target_namespaces

Storr namespaces for targets

target

Customize a target in drake_plan().

text_drake_graph_impl

Internal function with a drake_config() argument

text_drake_graph

Show a workflow graph as text in your terminal window.

this_cache

Get the cache at the exact file path specified.

tracked

List the targets and imports that are reproducibly tracked.

transform_plan

Transform a plan

transformations

Transformations in drake_plan().

trigger

Customize the decision rules for rebuilding targets

triggers

List the old drake triggers.

type_sum.expr_list

Type summary printing

use_drake

Use drake in a project

vis_drake_graph_impl

Internal function with a drake_config() argument

vis_drake_graph

Show an interactive visual network representation of your drake projec...

walk_code

Static code analysis

which_clean

Which targets will clean() invalidate?

workflow

workflow

workplan

workplan

A general-purpose computational engine for data analysis, drake rebuilds intermediate data objects when their dependencies change, and it skips work when the results are already up to date. Not every execution starts from scratch, there is native support for parallel and distributed computing, and completed projects have tangible evidence that they are reproducible. Extensive documentation, from beginner-friendly tutorials to practical examples and more, is available at the reference website <https://docs.ropensci.org/drake/> and the online manual <https://books.ropensci.org/drake/>.

  • Maintainer: William Michael Landau
  • License: GPL-3
  • Last published: 2024-12-04