Learn R Programming

⚠️There's a newer version (7.13.11) of this package.Take me there.

drake (version 6.1.0)

A Pipeline Toolkit for Reproducible Computation at Scale

Description

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, 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 and the online manual .

Copy Link

Version

Install

install.packages('drake')

Monthly Downloads

1,576

Version

6.1.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/ropensci/drake

Maintainer

Landau William

Last Published

October 26th, 2018

Functions in drake (6.1.0)

clean_mtcars_example

Clean the mtcars example from drake_example("mtcars")

Row-bind together drake plans

available_hash_algos

List the available hash algorithms for drake caches.

build_drake_graph

Create the igraph dependency network of your project.

cache_namespaces

List all the storr cache namespaces used by drake.

Makefile_recipe

For make(..., parallelism = "Makefile"), see what your Makefile recipes will look like in advance.

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

Deprecated function config

Deprecated function analyses

List the time it took to build each target/import.

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

Deprecated function build_graph

configure_cache

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

Enumerate cached targets or check if a target is cached.

Deprecated function check

Check a workflow plan data frame for obvious errors.

Remove targets/imports from the cache.

default_system2_args

Deprecated function default_system2_args

cmq_staged_build

Build a target using the clustermq_staged backend

Run a function in debug mode.

default_Makefile_args

Return the default value of the args argument to make().

Turn an R script file or knitr / R Markdown report into a drake workflow plan data frame.

cleaned_namespaces

For drake caches, list the storr namespaces that are cleaned during a call to clean().

default_verbose

Default verbosity for drake

default_recipe_command

Show the default recipe command for make(..., parallelism = "Makefile").

default_short_hash_algo

Return the default short hash algorithm for make().

Build a target using the clustermq backend

dataframes_graph

Deprecated function dataframes_graph

List the dependencies of a function, workflow plan command, or knitr report source file.

Do the prework in the prework argument to make().

List the dependencies of one or more targets

Get diagnostic metadata on a target.

dataset_wildcard

Show the dataset wildcard used in plan_analyses() and plan_summaries().

drake is a pipeline toolkit (https://github.com/pditommaso/awesome-pipeline) and a scalable, R-focused solution for reproducibility and high-performance computing.

default_long_hash_algo

Return the default long hash algorithm for make().

default_Makefile_command

Give the default command argument to make().

default_cache_path

Return the default file path of the drake/storr cache.

default_parallelism

Show the default parallelism argument to make() for your system.

Do garbage collection on the drake cache.

drake_hpc_template_files

List the available example template files for deploying work to a cluster / job scheduler.

drake_future_task

Task passed to individual futures in the "future" backend

drake_hpc_template_file

Write a template file for deploying work to a cluster / job scheduler.

drake_batchtools_tmpl_file

Deprecated. Get a template file for execution on a cluster.

default_graph_title

Return the default title for graph visualizations

Show a ggraph/ggplot2 representation of your drake project.

drake_graph_info

Create the underlying node and edge data frames behind vis_drake_graph().

dependency_profile

Find out why a target is out of date.

Build/process a single target or import.

Deprecated function examples_drake

Deprecated function expand

List the targets that failed in the last call to make().

Declare the file inputs of a workflow plan command.

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

Create a workflow plan data frame for the plan argument of make().

List the targets that either (1) are currently being built during a make(), or (2) were being built if the last make() quit unexpectedly.

List all the imports in the drake cache.

Deprecated. List the dependencies of a function, workflow plan command, or knitr report source file.

drake_plan_source

Show the code required to produce a given workflow plan data frame

Create the internal runtime parameter list used internally in make().

Download and save the code and data files of an example drake-powered project.

Show drake's color palette.

Run a single target's command in debug mode.

drake_cache_log

Get a table that represents the state of the cache.

List the names of all the drake examples.

Make a new drake cache.

List the targets that are out of date.

Create replicates of targets.

drake_cache_log_file

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

Turn valid expressions into character strings.

Expose all the imports in a package so make() can detect all the package's nested functions.

Output a random tip about drake.

Gather multiple groupings of targets

Search up the file system for the nearest drake cache.

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

Put quotes around each element of a character vector.

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

load_basic_example

Deprecated function load_basic_example

Remove leading and trailing escaped quotes from character strings.

Return the sessionInfo() of the last call to make().

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

Write commands to combine several targets into one or more overarching targets.

render_drake_ggraph

Render a static ggplot2/ggraph visualization from drake_graph_info() output.

Deprecated function example_drake

Declare the file outputs of a workflow plan command.

eager_load_target

Load a target right away (internal function)

Tell drake that you want information on a file (target or import), not an ordinary object.

render_drake_graph

Render a visualization using the data frames generated by drake_graph_info().

Deprecated function evaluate

Deprecated function summaries

Define custom columns in a drake_plan().

Find the drake dependencies of a dynamic knitr report target.

Get the drake cache, optionally searching up the file system.

Declare the knitr/rmarkdown source files of a workflow plan command.

Ignore components of commands and imported functions.

Run the master process of the "future_lapply" backend.

Just build the targets.

parallelism_choices

List the types of supported parallel computing in drake.

make_with_config

Run make(), on an existing internal configuration list.

Get the long hash algorithm of a drake cache.

Deprecated function plan

Deprecated function gather

Generate a workflow plan data frame to analyze multiple datasets using multiple methods of analysis.

Run your project (build the outdated targets).

Deprecated function plan_drake

Internal function to launch a master process.

Internal function to launch a master process or persistent worker.

load_main_example

Load the main example from drake_example("main")

load_mtcars_example

Load the mtcars example from drake_example("mtcars")

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

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

max_useful_jobs

Deprecated function

read_drake_plan

Read the workflow plan from your last attempted call to make().

Build a target inside a Makefile during make(..., parallelism = "Makefile").

predict_load_balancing

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

read_drake_seed

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

predict_runtime

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

read_drake_graph

Read the igraph dependency network from your last attempted call to make().

read_drake_meta

Deprecated: read the metadata of a target or import.

message_sink_hook

prepare_distributed

Do the preparatory work for make() with a distributed computing backend (see the parallelism argument of make()).

Get the build progress of your targets during a make().

migrate_drake_project

Deprecated: reconfigure an old project (built with drake <= 4.4.0) to be compatible with later versions of drake.

Just make the imports.

plan_to_notebook

Turn a drake workflow plan data frame into an R notebook,

Deprecated function plot_graph

Internal function to be called by make_with_config()

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

Load an existing drake files system cache if it exists or create a new one otherwise.

prune_drake_graph

Prune the dependency network of your project.

r_recipe_wildcard

Show the R recipe wildcard for make(..., parallelism = "Makefile").

output_sink_hook

Prune the evaluation environment

Reduce multiple groupings of targets

rate_limiting_times

Write commands to reduce several targets down to one.

Deprecated function render_graph

Objects exported from other packages

render_sankey_drake_graph

Render a Sankey diagram fromdrake_graph_info().

remote_hasty_build

Build a target using "hasty" parallelism

sankey_drake_graph

Show a Sankey graph of your drake project.

parallel_stages

Defunct function

Write an example shell.sh file required by make(..., parallelism = 'Makefile', prepend = 'SHELL=./shell.sh').

Generate a workflow plan data frame for summarizing multiple analyses of multiple datasets multiple ways.

Turn a drake workflow plan data frame into a plain R script file.

Deprecated function read_config

Deprecated function session

Get the cache at the exact file path specified.

read_drake_config

Read the cached drake_config() list from the last make().

Write dummy timestamp files for make(..., parallelism = "Makefile").

Deprecated function workflow

Deprecated function read_graph

Deprecated function workplan

Get the short hash algorithm of a drake cache.

static_drake_graph

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

store_drake_config

Store an internal configuration list from drake_config().

Deprecated function read_plan

render_static_drake_graph

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

Show how a target/import was produced.

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

List the targets and imports that are reproducibly tracked.

Customize the decision rules for rebuilding targets

vis_drake_graph

Show an interactive visual network representation of your drake project.

Deprecated. List the old drake triggers.

target_namespaces

For drake caches, list the storr cache namespaces that store target-level information.

Run a unit test in a way that quarantines the side effects from your workspace and file system.

Deprecated function backend

clean_main_example

Clean the main example from drake_example("main")

analysis_wildcard

Show the analysis wildcard used in plan_summaries().

as_drake_filename

Deprecated function as_drake_filename

Deprecated function as_file