Learn R Programming

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

drake (version 6.2.1)

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

Copy Link

Version

Install

install.packages('drake')

Monthly Downloads

1,576

Version

6.2.1

License

GPL-3

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/ropensci/drake

Maintainer

Landau William

Last Published

December 10th, 2018

Functions in drake (6.2.1)

Deprecated function build_graph

Makefile_recipe

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

Deprecated function analyses

Check a workflow plan data frame for obvious errors.

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

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

Remove targets/imports from the cache.

Deprecated function as_file

Deprecated function backend

available_hash_algos

List the available hash algorithms for drake caches.

cleaned_namespaces

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

Row-bind together drake plans

Deprecated function config

clean_main_example

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

analysis_wildcard

Show the analysis wildcard used in plan_summaries().

Build a target using the clustermq backend

clean_mtcars_example

Clean the mtcars example from drake_example("mtcars")

Run a function in debug mode.

configure_cache

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

default_Makefile_args

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

as_drake_filename

Deprecated function as_drake_filename

default_graph_title

Return the default title for graph visualizations

default_Makefile_command

Give the default command argument to make().

default_cache_path

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

default_hasty_build

Build a target using "hasty" parallelism

Enumerate cached targets or check if a target is cached.

default_verbose

Default verbosity for drake

drake: A pipeline toolkit for reproducible computation at scale.

dependency_profile

Find out why a target is out of date.

cache_namespaces

List all the storr cache namespaces used by drake.

Deprecated function check

dataframes_graph

Deprecated function dataframes_graph

dataset_wildcard

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

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

Build/process a single target or import.

drake_batchtools_tmpl_file

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

drake_cache_log

Get a table that represents the state of the cache.

cmq_staged_build

Build a target using the clustermq_staged backend

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

default_long_hash_algo

Return the default long hash algorithm for make().

drake_hpc_template_files

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

default_short_hash_algo

Return the default short hash algorithm for make().

List the dependencies of one or more targets

drake_future_task

Task passed to individual futures in the "future" backend

Do garbage collection on the drake cache.

default_system2_args

Deprecated function default_system2_args

default_recipe_command

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

default_parallelism

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

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

drake_get_session_info

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

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

Show a ggraph/ggplot2 representation of your drake project.

Deprecated function evaluate

Get diagnostic metadata on a target.

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

Run a single target's command in debug mode.

Get the environment where drake builds targets

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

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

eager_load_target

Load a target right away (internal function)

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

Deprecated function expand

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

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

Create replicates of targets.

drake_cache_log_file

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

List the names of all the drake examples.

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

Deprecated function gather

Gather multiple groupings of targets

drake_plan_source

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

Put quotes around each element of a character vector.

load_mtcars_example

Load the mtcars example.

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

Get the long hash algorithm of a drake cache.

Show drake's color palette.

Deprecated function example_drake

parallelism_choices

List the types of supported parallel computing in drake.

Internal function to launch a master process.

Internal function to launch a master process or persistent worker.

Deprecated function examples_drake

predict_load_balancing

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

Deprecated function plan

predict_runtime

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

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

Write commands to reduce several targets down to one.

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.

Just make the imports.

Run your project (build the outdated targets).

remote_hasty_build

Build a target on a remote worker using "hasty" parallelism

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

sankey_drake_graph

Show a Sankey graph of your drake project.

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

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

Deprecated function session

Deprecated function summaries

max_useful_jobs

Deprecated function

output_sink_hook

parallel_stages

Defunct function

prepare_distributed

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

Turn valid expressions into character strings.

Declare the file inputs of a workflow plan command.

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

read_drake_seed

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

Deprecated function read_graph

Output a random tip about drake.

Declare the file outputs of a workflow plan command.

Deprecated function render_graph

Remove leading and trailing escaped quotes from character strings.

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

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

Find the drake dependencies of a dynamic knitr report target.

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

render_sankey_drake_graph

Render a Sankey diagram fromdrake_graph_info().

Define custom columns in a drake_plan().

Internal function to be called by make_with_config()

List the targets and imports that are reproducibly tracked.

Run the master process of the "future_lapply" backend.

Just build the targets.

Search up the file system for the nearest drake cache.

message_sink_hook

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

Customize the decision rules for rebuilding targets

migrate_drake_project

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

static_drake_graph

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

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

store_drake_config

Store an internal configuration list from drake_config().

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.

make_with_config

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

prune_drake_graph

Prune the dependency network of your project.

Ignore components of commands and imported functions.

List all the imports in the drake cache.

Manage in-memory targets

load_basic_example

Deprecated function load_basic_example

r_recipe_wildcard

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

Make a new drake cache.

List the targets that are out of date.

load_main_example

Deprecated: load the main example.

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

read_drake_meta

Deprecated: read the metadata of a target or import.

read_drake_plan

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

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

plan_to_notebook

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

Get the short hash algorithm of a drake cache.

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

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

Deprecated function plot_graph

read_drake_config

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

read_drake_graph

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

target_namespaces

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

Deprecated function read_plan

Deprecated function workflow

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

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

render_static_drake_graph

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

Deprecated function plan_drake

rate_limiting_times

Deprecated function workplan

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

Deprecated function read_config

Show how a target/import was produced.

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

Reduce multiple groupings of targets

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().

Get the cache at the exact file path specified.

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

Deprecated. List the old drake triggers.

vis_drake_graph

Show an interactive visual network representation of your drake project.

build_drake_graph

Deprecated function build_drake_graph