Learn R Programming

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

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

Version

5.3.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Landau William

Last Published

July 19th, 2018

Functions in drake (5.3.0)

default_trigger

Return the default trigger.
default_Makefile_command

check

Deprecated function check
default_Makefile_args

gather_plan

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

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

Remove leading and trailing escaped quotes from character strings.
missed

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

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

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

drake_cache_log_file

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

Load a target right away (internal function)
drake_graph_info

max_useful_jobs

Deprecated function
mk

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

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

List the dependencies of one or more targets
deps_code

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

plan_analyses

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

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

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

Deprecated function config
default_short_hash_algo

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

Deprecated function dataframes_graph
silencer_hook

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

Return the default title for graph visualizations
cache_path

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

Write commands to reduce several targets down to one.
plan_drake

Deprecated function plan_drake
reexports

Objects exported from other packages
default_system2_args

Deprecated function default_system2_args
deps

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

Get diagnostic metadata on a target.
drake_build

Build/process a single target or import.
dependency_profile

Return the detailed dependency profile of the target.
do_prework

drake_future_task

Task passed to individual futures in the "future" backend
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.
dataset_wildcard

static_drake_graph

Show static graph representation of your drake project.
drake_batchtools_tmpl_file

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

Turn valid expressions into character strings.
drake_example

Save the source code files of a drake example.
empty_hook

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

Do garbage collection on the drake cache.
workflow

Deprecated function workflow
drake_examples

List the names of all the drake examples.
default_parallelism

evaluate

Deprecated function evaluate
fl_master

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

Default verbosity for drake
drake_tip

Output a random tip about drake.
drake_cache_log

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

Deprecated function workplan
gather

Deprecated function gather
default_recipe_command

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

Declare the file outputs of a workflow plan command.
load_basic_example

Deprecated function load_basic_example
load_mtcars_example

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

Show drake's color palette.
knitr_in

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

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

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

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

drake_hpc_template_files

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

Get the long hash algorithm of a drake cache.
drake_meta

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

Internal function to launch a master process.
drake_quotes

Put quotes around each element of a character vector.
output_sink_hook

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

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

Deprecated function examples_drake
expand_plan

Create replicates of targets.
mc_process

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

Deprecated function expand
find_cache

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

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

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

Defunct function
example_drake

Deprecated function example_drake
predict_load_balancing

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

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

Make a new drake cache.
make_session

read_graph

Deprecated function read_graph
make_targets

Just build the targets.
predict_runtime

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

Ignore components of commands and imported functions.
failed

read_plan

Deprecated function read_plan
imported

List all the imports in the drake cache.
file_in

Declare the file inputs of a workflow plan command.
knitr_deps

Find the drake dependencies of a dynamic knitr report target.
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.
parallelism_choices

List the types of supported parallel computing in drake.
outdated

List the targets that are out of date.
this_cache

Get the cache at the exact file path specified.
test_with_dir

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

Deprecated function session
shell_file

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

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

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

Deprecated function plot_graph
migrate_drake_project

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

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

Deprecated function plan
read_config

Deprecated function read_config
prepare_distributed

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

render_sankey_drake_graph

rate_limiting_times

Defunct
readd

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

make

Run your project (build the outdated targets).
recover_cache

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

read_drake_plan

short_hash

Get the short hash algorithm of a drake cache.
show_source

Show how a target/import was produced.
make_imports

Just make the imports.
read_drake_seed

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

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

Prune the dependency network of your project.
sankey_drake_graph

Show a Sankey graph of your drake project.
prune_envir

Prune the evaluation environment
read_drake_graph

time_stamps

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

List the targets and imports that are reproducibly tracked.
read_drake_meta

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

store_drake_config

render_graph

Deprecated function render_graph
target

summaries

Deprecated function summaries
target_namespaces

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

List the available drake triggers.
vis_drake_graph

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

Create the igraph dependency network of your project.
build_graph

Deprecated function build_graph
analyses

Deprecated function analyses
as_drake_filename

Deprecated function as_drake_filename
build_times

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

Enumerate cached targets or check if a target is cached.
available_hash_algos

List the available hash algorithms for drake caches.
check_plan

Check a workflow plan data frame for obvious errors.
built

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

Row-bind together drake plans
cache_namespaces

List all the storr cache namespaces used by drake.
analysis_wildcard

as_file

Deprecated function as_file
backend

Deprecated function backend
cmq_staged_build

Build a target using the clustermq backend
Makefile_recipe

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

clean

Remove targets/imports from the cache.