Learn R Programming

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

drake (version 5.0.0)

Data Frames in R for Make

Description

An R-focused pipeline toolkit for reproducible code and high-performance computing.

Copy Link

Version

Install

install.packages('drake')

Monthly Downloads

1,313

Version

5.0.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Landau William

Last Published

January 26th, 2018

Functions in drake (5.0.0)

as_file

Deprecated function as_file
available_hash_algos

List the available hash algorithms for drake caches.
analysis_wildcard

as_drake_filename

Converts an ordinary character string into a filename understandable by drake.
build_graph

Deprecated function build_graph
build_times

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

Deprecated function backend
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.
built

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

List all the storr cache namespaces used by drake.
default_Makefile_args

default_Makefile_command

config

Deprecated function config
configure_cache

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

analyses

Deprecated function analyses
drake_batchtools_tmpl_file

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

Build/process a single target or import.
drake_session

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

Turn valid expressions into character strings.
cache_path

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

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

default_long_hash_algo

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

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

default_recipe_command

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

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

Deprecated function check
check_plan

Check a workflow plan data frame for obvious errors.
default_cache_path

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

Run your project (build the outdated targets).
make_imports

Just make the imports.
output_sink_hook

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

do_prework

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

default_trigger

Return the default trigger.
dependency_profile

Return the detailed dependency profile of the target.
drake_plan

drake_cache_log

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

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

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

Put quotes around each element of a character vector.
drake_tip

Output a random tip about drake.
drake_unquote

Remove leading and trailing escaped quotes from character strings.
clean

Remove targets/imports from the cache.
cleaned_namespaces

drake_config

default_system2_args

Deprecated function default_system2_args
drake_meta

Compute the metadata of a target or import.
drake_palette

Show drake's color palette.
empty_hook

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

Deprecated function evaluate
gather

Deprecated function gather
diagnose

Get the last stored error log of a target that failed to build, or list the targets with error logs.
drake_examples

List the names of all the drake examples.
drake_gc

Do garbage collection on the drake cache.
expand_plan

Create replicates of targets.
failed

max_useful_jobs

Suggest an upper bound on the jobs in the next call to make(..., jobs = YOUR_CHOICE).
message_sink_hook

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

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

Load multiple targets or imports from the drake cache.
long_hash

Get the long hash algorithm of a drake cache.
next_stage

outdated

List the targets that are out of date.
read_drake_meta

Read the metadata of a target or import.
read_drake_plan

silencer_hook

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

parallelism_choices

List the types of supported parallel computing in drake.
plan

Deprecated function plan
prune_drake_graph

Prune the dependency network of your project.
r_recipe_wildcard

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

Return a data frame of elapsed build times of the rate-limiting targets of a drake project.
find_cache

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

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

load_basic_example

Load the basic example from drake_example("basic")
drake_example

Save the source code files of a drake example.
examples_drake

Deprecated function examples_drake
expand

Deprecated function expand
parallel_stages

Show how make() will build your targets in successive parallelizable stages.
plan_analyses

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

Deprecated function plan_drake
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.
knitr_deps

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

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

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

rescue_cache

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

Deprecated function session
example_drake

Deprecated function example_drake
get_cache

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

List all the imports in the drake cache.
possible_targets

predict_runtime

Predict the elapsed runtime of the next call to `make()`.
missed

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

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

readd

Read and return a drake target or import from the cache.
shell_file

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

Get the short hash algorithm of a drake cache.
triggers

List the available drake triggers.
vis_drake_graph

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

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

render_graph

Deprecated function render_graph
workflow

Deprecated function workflow
read_config

Deprecated function read_config
summaries

Deprecated function summaries
target_namespaces

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

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

Just build the targets.
make_with_config

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

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

Get the cache at the exact file path specified.
workplan

Deprecated function workplan
new_cache

Make a new drake cache.
plan_summaries

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

Deprecated function plot_graph
read_graph

Deprecated function read_graph
read_plan

Deprecated function read_plan
time_stamps

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

List the targets and imports that are reproducibly tracked.