Learn R Programming

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

drake (version 5.1.2)

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

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Landau William

Last Published

April 10th, 2018

Functions in drake (5.1.2)

clean

Remove targets/imports from the cache.
default_long_hash_algo

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

Return the detailed dependency profile of the target.
default_Makefile_command

default_parallelism

drake_unquote

Remove leading and trailing escaped quotes from character strings.
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.
failed

dataframes_graph

drake_build

Build/process a single target or import.
drake_batchtools_tmpl_file

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

Load a target right away (internal function)
default_verbose

Default verbosity for drake
configure_cache

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

Return the default trigger.
expand_plan

Create replicates of targets.
empty_hook

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

Deprecated function evaluate
default_system2_args

Deprecated function default_system2_args
expose_imports

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

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

file_in

Declare the file inputs of a workflow plan command.
default_Makefile_args

default_hook

default_graph_title

default_short_hash_algo

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

Show the default recipe command for make(..., parallelism = "Makefile").
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.
imported

List all the imports in the drake cache.
get_cache

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

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

ignore

Ignore components of commands and imported functions.
drake_examples

List the names of all the drake examples.
drake_future_task

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

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

Get diagnostic metadata on a target.
drake_palette

Show drake's color palette.
missed

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

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

Just make the imports.
progress

make

Run your project (build the outdated targets).
drake_plan

prune_drake_graph

Prune the dependency network of your project.
drake_gc

Do garbage collection on the drake cache.
gather_plan

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

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

Deprecated function example_drake
message_sink_hook

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

Deprecated function plot_graph
gather

Deprecated function gather
do_prework

migrate_drake_project

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

drake_meta

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

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

rate_limiting_times

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

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

Put quotes around each element of a character vector.
read_drake_plan

make_targets

Just build the targets.
read_drake_seed

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

Deprecated function examples_drake
drake_session

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

Deprecated function summaries
short_hash

Get the short hash algorithm of a drake cache.
reduce_plan

Write commands to reduce several targets down to one.
reexports

Objects exported from other packages
target_namespaces

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

Deprecated function expand
silencer_hook

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

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

drake_config

new_cache

Make a new drake cache.
next_stage

predict_runtime

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

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

Save the source code files of a drake example.
drake_strings

Turn valid expressions into character strings.
read_graph

Deprecated function read_graph
read_plan

Deprecated function read_plan
drake_tip

Output a random tip about drake.
file_store

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

Declare the file outputs of a workflow plan command.
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.
rescue_cache

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

Get the long hash algorithm of a drake cache.
triggers

List the available drake triggers.
session

Deprecated function session
vis_drake_graph

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

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

List the types of supported parallel computing in drake.
plan_analyses

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

Deprecated function plan
read_drake_config

read_config

Deprecated function read_config
render_drake_graph

make_with_config

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

Deprecated function render_graph
max_useful_jobs

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

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

List the targets that are out of date.
output_sink_hook

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

Deprecated function plan_drake
tracked

List the targets and imports that are reproducibly tracked.
plan_summaries

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

read_drake_meta

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

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

Load an existing drake files system cache if it exists or create a new one otherwise.
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.
workflow

Deprecated function workflow
workplan

Deprecated function workplan
Makefile_recipe

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

available_hash_algos

List the available hash algorithms for drake caches.
as_file

Deprecated function as_file
backend

Deprecated function backend
analyses

Deprecated function analyses
as_drake_filename

Deprecated function as_drake_filename
cached

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

build_drake_graph

Create the igraph dependency network of your project.
build_graph

Deprecated function build_graph
cache_namespaces

List all the storr cache namespaces used by drake.
check_plan

Check a workflow plan data frame for obvious errors.
cache_path

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

Deprecated function check
config

Deprecated function config
bind_plans

Row-bind together drake plans
build_times

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

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