Learn R Programming

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

drake (version 5.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, 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,599

Version

5.2.1

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Landau William

Last Published

June 19th, 2018

Functions in drake (5.2.1)

build_drake_graph

Create the igraph dependency network of your project.
Makefile_recipe

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

dataset_wildcard

check

Deprecated function check
analysis_wildcard

configure_cache

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

deps_targets

List the dependencies of one or more targets
default_system2_args

Deprecated function default_system2_args
build_graph

Deprecated function build_graph
default_trigger

Return the default trigger.
analyses

Deprecated function analyses
cleaned_namespaces

as_drake_filename

Deprecated function as_drake_filename
default_Makefile_command

config

Deprecated function config
default_cache_path

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

Check a workflow plan data frame for obvious errors.
drake_batchtools_tmpl_file

Write the batchtools template file from one of the built-in drake examples.
drake_unquote

Remove leading and trailing escaped quotes from character strings.
drake_build

Build/process a single target or import.
default_long_hash_algo

Return the default long hash algorithm for make().
empty_hook

A hook argument to make() for which no targets get built and no imports get processed.
eager_load_target

Load a target right away (internal function)
clean

Remove targets/imports from the cache.
default_verbose

Default verbosity for drake
default_parallelism

dependency_profile

Return the detailed dependency profile of the target.
diagnose

Get diagnostic metadata on a target.
drake_future_task

Task passed to individual futures in the "future" backend
evaluate

Deprecated function evaluate
drake_config

drake_examples

List the names of all the drake examples.
build_times

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

Save the source code files of a drake example.
drake_quotes

Put quotes around each element of a character vector.
drake_strings

Turn valid expressions into character strings.
find_cache

Search up the file system for the nearest drake cache.
drake_session

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

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

Get a table that represents the state of the cache.
example_drake

Deprecated function example_drake
evaluate_plan

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

Output a random tip about drake.
deps_code

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

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

Deprecated function examples_drake
drake_palette

Show drake's color palette.
drake_plan

failed

file_in

Declare the file inputs of a workflow plan command.
fl_master

Run the master process of the "future_lapply" backend.
built

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

Deprecated function gather
default_hook

default_graph_title

default_recipe_command

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

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

Ignore components of commands and imported functions.
loadd

Load one or more targets or imports from the drake cache.
default_short_hash_algo

Return the default short hash algorithm for make().
do_prework

in_progress

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

Deprecated function expand
knitr_deps

Find the drake dependencies of a dynamic knitr report target.
message_sink_hook

An example hook argument to make() that redirects error messages to files.
imported

List all the imports in the drake cache.
load_basic_example

Deprecated function load_basic_example
drake-package

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

Get the long hash algorithm of a drake cache.
migrate_drake_project

Reconfigure an old project (built with drake <= 4.4.0) to be compatible with later versions of drake.
drake_gc

Do garbage collection on the drake cache.
parallelism_choices

List the types of supported parallel computing in drake.
expand_plan

Create replicates of targets.
drake_meta

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

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

Declare the file outputs of a workflow plan command.
get_cache

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

Load the mtcars example from drake_example("mtcars")
gather_plan

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

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

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

Deprecated function plan
make

Run your project (build the outdated targets).
mk

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

Just make the imports.
knitr_in

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

Make a new drake cache.
make_session

outdated

List the targets that are out of date.
make_targets

Just build the targets.
predict_load_balancing

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

An example hook argument to make() that redirects output messages to files.
legend_nodes

possible_targets

mc_process

Internal function to launch a master process or persistent worker.
show_source

Show how a target/import was produced.
short_hash

Get the short hash algorithm of a drake cache.
vis_drake_graph

Show an interactive visual network representation of your drake project.
readd

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

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

Internal function to launch a master process.
read_plan

Deprecated function read_plan
parallel_stages

Defunct function
plot_graph

Deprecated function plot_graph
workflow

Deprecated function workflow
make_with_config

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

Deprecated function
prune_drake_graph

Prune the dependency network of your project.
progress

plan_analyses

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

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

Prune the evaluation environment
rate_limiting_times

Defunct
r_recipe_wildcard

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

Write commands to reduce several targets down to one.
plan_drake

Deprecated function plan_drake
predict_runtime

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

Deprecated function read_config
render_graph

Deprecated function render_graph
read_drake_seed

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

Deprecated: read the metadata of a target or import.
read_graph

Deprecated function read_graph
reexports

Objects exported from other packages
render_drake_graph

read_drake_plan

rescue_cache

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

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

summaries

Deprecated function summaries
tracked

List the targets and imports that are reproducibly tracked.
session

Deprecated function session
read_drake_config

read_drake_graph

silencer_hook

An example hook argument to make() that redirects output and error messages
triggers

List the available drake triggers.
store_drake_config

target_namespaces

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

Get the cache at the exact file path specified.
shell_file

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

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

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

Deprecated function workplan
bind_plans

Row-bind together drake plans
cache_path

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

List the available hash algorithms for drake caches.
as_file

Deprecated function as_file
backend

Deprecated function backend
cache_namespaces

List all the storr cache namespaces used by drake.
cached

Enumerate cached targets or check if a target is cached.