Data Frames in R for Make


[Up] [Top]

Documentation for package ‘drake’ version 5.1.2

Help Pages

A B C D E F G I K L M N O P R S T V

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

-- A --

analysis_wildcard Show the analysis wildcard used in 'plan_summaries()'.
available_hash_algos List the available hash algorithms for drake caches.

-- B --

bind_plans Row-bind together drake plans
build_drake_graph Create the 'igraph' dependency network of your project.
build_times List the time it took to build each target/import.
built List all the built targets (non-imports) in the cache.

-- C --

cached Enumerate cached targets or check if a target is cached.
cache_namespaces List all the 'storr' cache namespaces used by drake.
cache_path Return the file path where the cache is stored, if applicable.
check_plan Check a workflow plan data frame for obvious errors.
clean Remove targets/imports from the cache.
cleaned_namespaces For drake caches, list the 'storr' namespaces that are cleaned during a call to 'clean()'.
configure_cache Configure the hash algorithms, etc. of a drake cache.

-- D --

dataframes_graph Create the underlying node and edge data frames behind 'vis_drake_graph()'.
dataset_wildcard Show the dataset wildcard used in 'plan_analyses()' and 'plan_summaries()'.
default_cache_path Return the default file path of the drake/storr cache.
default_hook Default 'hook' argument to 'make()'.
default_long_hash_algo Return the default long hash algorithm for 'make()'.
default_Makefile_args Return the default value of the 'args' argument to 'make()'.
default_Makefile_command Give the default 'command' argument to 'make()'.
default_parallelism Show the default 'parallelism' argument to 'make()' for your system.
default_recipe_command Show the default recipe command for 'make(..., parallelism = "Makefile")'.
default_short_hash_algo Return the default short hash algorithm for 'make()'.
default_trigger Return the default trigger.
dependency_profile Return the detailed dependency profile of the target.
deps List the dependencies of a function, workflow plan command, or knitr report source file.
diagnose Get diagnostic metadata on a target.
drake Drake is a pipeline toolkit (<URL: https://github.com/pditommaso/awesome-pipeline>) and a scalable, R-focused solution for reproducibility and high-performance computing.
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_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.
drake_config Create the internal runtime parameter list used internally in 'make()'.
drake_example Save the source code files of a drake example.
drake_examples List the names of all the drake examples.
drake_gc Do garbage collection on the drake cache.
drake_graph Show an interactive visual network representation of your drake project.
drake_meta Compute the initial pre-build metadata of a target or import.
drake_palette Show drake's color palette.
drake_plan Create a workflow plan data frame for the 'plan' argument of 'make()'.
drake_quotes Put quotes around each element of a character vector.
drake_session Return the 'sessionInfo()' of the last call to 'make()'.
drake_strings Turn valid expressions into character strings.
drake_tip Output a random tip about drake.
drake_unquote Remove leading and trailing escaped quotes from character strings.

-- E --

empty_hook A 'hook' argument to 'make()' for which no targets get built and no imports get processed.
evaluate_plan Use wildcard templating to create a workflow plan data frame from a template data frame.
expand_plan Create replicates of targets.
expose_imports Expose all the imports in a package so 'make()' can detect all the package's nested functions.

-- F --

failed List the targets that failed in the last call to 'make()'.
file_in Declare the file inputs of a workflow plan command.
file_out Declare the file outputs of a workflow plan command.
file_store Tell 'drake' that you want information on a _file_ (target or import), not an ordinary object.
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.

-- G --

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.

-- I --

ignore Ignore components of commands and imported functions.
imported List all the imports in the drake cache.
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.

-- K --

knitr_deps Find the drake dependencies of a dynamic knitr report target.
knitr_in Declare the 'knitr'/'rmarkdown' source files of a workflow plan command.

-- L --

legend_nodes Create the nodes data frame used in the legend of 'vis_drake_graph()'.
loadd Load one or more targets or imports from the drake cache.
load_basic_example Load the basic example from 'drake_example("basic")'
long_hash Get the long hash algorithm of a drake cache.

-- M --

make Run your project (build the outdated targets).
Makefile_recipe For 'make(..., parallelism = "Makefile")', see what your 'Makefile' recipes will look like in advance.
make_imports Just make the imports.
make_targets Just build the targets.
make_with_config Run 'make()', on an existing internal configuration list.
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.
migrate_drake_project Reconfigure an old project (built with drake <= 4.4.0) to be compatible with later versions of drake.
missed Report any import objects required by your drake_plan plan but missing from your workspace.

-- N --

new_cache Make a new 'drake' cache.
next_stage List the targets that will be built in the first parallelizable stage of the next call to 'make()'.

-- O --

outdated List the targets that are out of date.
output_sink_hook An example 'hook' argument to 'make()' that redirects output messages to files.

-- P --

parallelism_choices List the types of supported parallel computing in drake.
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_summaries Generate a workflow plan data frame for summarizing multiple analyses of multiple datasets multiple ways.
predict_runtime Predict the elapsed runtime of the next call to 'make()'.
progress Get the build progress of your targets during a 'make()'.
prune_drake_graph Prune the dependency network of your project.

-- R --

rate_limiting_times Return a data frame of elapsed build times of the rate-limiting targets of a drake project.
readd Read and return a drake target/import from the cache.
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()'.
read_drake_plan Read the workflow plan from your last attempted call to 'make()'.
read_drake_seed Read the pseudo-random number generator seed of the project.
recover_cache Load an existing drake files system cache if it exists or create a new one otherwise.
reduce_plan Write commands to reduce several targets down to one.
render_drake_graph Render a visualization using the data frames generated by 'dataframes_graph()'.
rescue_cache Try to repair a drake cache that is prone to throwing 'storr'-related errors.
r_recipe_wildcard Show the R recipe wildcard for 'make(..., parallelism = "Makefile")'.

-- S --

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.
silencer_hook An example 'hook' argument to 'make()' that redirects output and error messages

-- T --

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.
tracked List the targets and imports that are reproducibly tracked.
triggers List the available drake triggers.

-- V --

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