Man pages for wlandau-lilly/drake
A Pipeline Toolkit for Reproducible Computation at Scale

analysesanalyses \lifecycledefunct
analysis_wildcardShow the analysis wildcard used in 'plan_summaries()'....
as_drake_filenameas_drake_filename \lifecycledefunct
as_fileas_file \lifecycledefunct
available_hash_algosList the available hash algorithms for drake caches....
backendbackend \lifecycledefunct
bind_plansRow-bind together drake plans \lifecyclestable
build_drake_graphFunction 'build_drake_graph' \lifecycledeprecated
build_graphbuild_graph \lifecycledefunct
build_timesSee the time it took to build each target. \lifecyclematuring
builtList all the built targets (non-imports) in the cache....
cachedList targets in the cache. \lifecyclematuring
cached_plannedList targets in both the plan and the cache....
cached_unplannedList targets in the cache but not the plan....
cache_namespacesList all the 'storr' cache namespaces used by drake....
cache_pathReturn the file path where the cache is stored, if...
cancelCancel a target mid-build \lifecycleexperimental
cancel_ifCancel a target mid-build under some condition...
checkcheck \lifecycledefunct
check_planCheck a workflow plan data frame for obvious errors....
cleanInvalidate and deregister targets. \lifecyclematuring
cleaned_namespacesAuxiliary storr namespaces \lifecycledeprecated
clean_main_exampleDeprecated: clean the main example from...
clean_mtcars_exampleClean the mtcars example from 'drake_example("mtcars")'...
cmq_buildBuild a target using the clustermq backend \lifecyclematuring
code_to_functionTurn a script into a function. \lifecycleexperimental
code_to_planTurn an R script file or 'knitr' / R Markdown report into a...
configconfig \lifecycledefunct
configure_cacheConfigure the hash algorithms, etc. of a drake cache....
dataframes_graphdataframes_graph \lifecycledefunct
dataset_wildcardShow the dataset wildcard used in 'plan_analyses()' and...
debug_and_runRun a function in debug mode. \lifecyclestable
default_graph_titleReturn the default title for graph visualizations...
default_long_hash_algoReturn the default long hash algorithm for 'make()'....
default_Makefile_argsDefault arguments of Makefile parallelism...
default_Makefile_commandDefault Makefile command \lifecycledeprecated
default_parallelismDefault parallel backend \lifecycledeprecated
default_recipe_commandDefault Makefile recipe command \lifecycledeprecated
default_short_hash_algoReturn the default short hash algorithm for 'make()'....
default_system2_argsdefault_system2_args \lifecycledefunct
default_verboseDefault verbosity \lifecycledeprecated
dependency_profileStates of the dependencies of a target \lifecycledeprecated
deprecate_wildcarddeprecate_wildcard \lifecycledefunct
depsdeps \lifecycledefunct
deps_codeList the dependencies of a function or command...
deps_knitrFind the drake dependencies of a dynamic knitr report target....
deps_profileFind out why a target is out of date. \lifecyclestable
deps_profile_implInternal function with a drake_config() argument
deps_targetList the dependencies of a target \lifecyclestable
deps_target_implInternal function with a drake_config() argument
deps_targetsSee the dependencies of a target \lifecycledeprecated
diagnoseGet diagnostic metadata on a target. \lifecyclematuring
doc_of_function_calldoc_of_function_call \lifecycledefunct
do_preworkDo the prework in the 'prework' argument to 'make()'....
drake_batchtools_tmpl_fileGet a template file for execution on a cluster....
drake_buildBuild/process a single target or import....
drake_build_implInternal function with a drake_config() argument
drake_cacheGet the cache of a 'drake' project. \lifecyclestable
drake_cache_logGet the state of the cache. \lifecyclematuring
drake_cache_log_fileGenerate a flat text log file to represent the state of the...
drake_cancelledList cancelled targets. \lifecyclematuring
drake_configEnding of _drake.R for r_make() and friends...
drake_debugRun a single target's command in debug mode.'...
drake_deps'drake_deps' helper
drake_deps_ht'drake_deps_ht' helper
drake_doneList done targets. \lifecyclematuring
drake_envirGet the environment where drake builds targets...
drake_exampleDownload the files of an example 'drake' project....
drake_examplesList the names of all the drake examples. \lifecyclestable
drake_failedList failed targets. \lifecyclematuring
drake_gcDo garbage collection on the drake cache. \lifecyclematuring
drake_get_session_infoSession info of the last call to 'make()'. \lifecyclematuring
drake_ggraphVisualize the workflow with 'ggraph'/'ggplot2'...
drake_ggraph_implInternal function with a drake_config() argument
drake_graph_infoPrepare the workflow graph for visualization \lifecyclestable
drake_graph_info_implInternal function
drake_historyHistory and provenance \lifecycleexperimental
drake_hpc_template_fileWrite a template file for deploying work to a cluster / job...
drake_hpc_template_filesList the available example template files for deploying work...
drake_metaCompute the initial pre-build metadata of a target or import....
drake-packagedrake: A pipeline toolkit for reproducible computation at...
drake_paletteShow drake's color palette. \lifecycledeprecated
drake_planCreate a drake plan for the 'plan' argument of 'make()'....
drake_plan_sourceShow the code required to produce a given 'drake' plan...
drake_progressGet the build progress of your targets \lifecyclematuring
drake_quotesPut quotes around each element of a character vector....
drake_runningList running targets. \lifecyclematuring
drake_sessionSession info of the last call to 'make()'....
drake_settings'drake_settings' helper
drake_sliceTake a strategic subset of a dataset. \lifecyclematuring
drake_stringsTurn valid expressions into character strings....
drake_tempfiledrake tempfile \lifecycleexperimental
drake_tipOutput a random tip about drake. \lifecycledeprecated
drake_triggers'drake_triggers' helper
drake_unquoteRemove leading and trailing escaped quotes from character...
evaluateevaluate \lifecycledefunct
evaluate_planUse wildcard templating to create a workflow plan data frame...
example_drakeexample_drake \lifecycledefunct
examples_drakeexamples_drake \lifecycledefunct
expandexpand \lifecycledefunct
expand_planDeprecated: create replicates of targets....
expose_importsExpose package functions and objects for analysis with drake...
failedList failed targets. \lifecycledeprecated
file_inDeclare input files and directories. \lifecyclestable
file_outDeclare output files and directories. \lifecyclestable
file_storeShow a file's encoded representation in the cache...
find_cacheSearch up the file system for the nearest drake cache....
find_knitr_docfind_knitr_doc \lifecycledefunct
find_projectSearch up the file system for the nearest root path of a...
from_planfrom_plan \lifecycledefunct
future_buildTask passed to individual futures in the '"future"' backend...
gathergather \lifecycledefunct
gather_byGather multiple groupings of targets \lifecycledeprecated
gather_planCombine targets \lifecycledeprecated
get_cacheThe default cache of a 'drake' project. \lifecycledeprecated
get_traceDeprecated, get a trace of a dynamic target's value....
id_chrName of the current target \lifecyclematuring
ignoreIgnore code \lifecyclestable
importedList all the imports in the drake cache. \lifecycledeprecated
in_progressList the targets in progress \lifecycledeprecated
is_function_callis_function_call \lifecycledefunct
isolate_exampleIsolate the side effects of an example. \lifecyclestable
knitr_depsDependencies of a knitr report \lifecycledeprecated
knitr_inDeclare 'knitr'/'rmarkdown' source files as dependencies....
legend_nodesCreate the nodes data frame used in the legend of the graph...
load_basic_exampleload_basic_example \lifecycledefunct
load_main_exampleLoad the main example. \lifecycledeprecated
load_mtcars_exampleLoad the mtcars example. \lifecyclematuring
long_hash'drake' now has just one hash algorithm per cache....
makeRun your project (build the outdated targets)....
Makefile_recipeDefault Makefile recipe \lifecycledeprecated
make_implInternal function with a drake_config() argument
make_importsJust process the imports \lifecycledeprecated
make_targetsJust make the targets \lifecycledeprecated
make_with_configApply make() with a pre-computed config object...
manage_memoryManage the in-memory dependencies of a target....
map_planCreate a plan that maps a function to a grid of arguments....
max_useful_jobsmax_useful_jobs \lifecycledefunct
migrate_drake_projectmigrate_drake_project \lifecycledefunct
missedReport any import objects required by your drake_plan plan...
missed_implInternal function with a drake_config() argument
new_cacheMake a new 'drake' cache. \lifecyclematuring
new_drake_deps'drake_deps' constructor
new_drake_deps_ht'drake_deps_ht' constructor
new_drake_settings'drake_settings' constructor
new_drake_triggers'drake_triggers' constructor
no_depsSuppress dependency detection. \lifecyclestable
outdatedList the targets that are out of date. \lifecyclestable
outdated_implInternal function with a drake_config() argument
parallelism_choicesNames of old parallel backends \lifecycledeprecated
parallel_stagesparallel_stages \lifecycledefunct
planplan \lifecycledefunct
plan_analysesSpecialized wildcard for analyses \lifecycledeprecated
plan_drakeplan_drake \lifecycledefunct
plan_summariesSpecialized wildcard for summaries \lifecycledeprecated
plan_to_codeTurn a 'drake' plan into a plain R script file....
plan_to_notebookTurn a 'drake' plan into an R notebook. \lifecyclequestioning
plot_graphplot_graph \lifecycledefunct
predict_load_balancingPredict parallel computing behavior \lifecycledeprecated
predict_runtimePredict the elapsed runtime of the next call to 'make()' for...
predict_runtime_implInternal function with a drake_config() argument
predict_workersPredict the load balancing of the next call to 'make()' for...
predict_workers_implInternal function with a drake_config() argument
process_importProcess an imported data object \lifecyclestable
progressGet the build progress of your targets \lifecycledeprecated
prune_drake_graphPrune the graph \lifecycledeprecated
rate_limiting_timesrate_limiting_times \lifecycledefunct
read_configread_config \lifecycledefunct
readdRead and return a drake target/import from the cache....
read_drake_configRead a config object from the cache \lifecycledeprecated
read_drake_graphRead a workflow graph from the cache \lifecycledeprecated
read_drake_metaread_drake_meta \lifecycledefunct
read_drake_planRead the plan from the cache \lifecycledeprecated
read_drake_seedRead the pseudo-random number generator seed of the project....
read_graphread_graph \lifecycledefunct
read_planread_plan \lifecycledefunct
read_traceRead a trace of a dynamic target. \lifecycleexperimental
recoverableList the most upstream _recoverable_ outdated targets....
recoverable_implInternal function with a drake_config() argument
recover_cacheLoad or create a drake cache \lifecycledeprecated
reduce_byReduce multiple groupings of targets \lifecycledeprecated
reduce_planWrite commands to reduce several targets down to one....
render_drake_ggraphVisualize the workflow with 'ggplot2'/'ggraph' using...
render_drake_graphRender a visualization using the data frames generated by...
render_graphrender_graph \lifecycledefunct
render_sankey_drake_graphRender a Sankey diagram from 'drake_graph_info()'....
render_static_drake_graphDeprecated: render a 'ggraph'/'ggplot2' representation of...
render_text_drake_graphShow a workflow graph as text in your terminal window using...
rescue_cacheTry to repair a drake cache that is prone to throwing...
r_makeLaunch a drake function in a fresh new R process...
r_recipe_wildcardDefault Makefile recipe wildcard \lifecycledeprecated
rs_addin_loaddLoadd target at cursor into global environment...
rs_addin_r_makeRStudio addin for r_make() \lifecyclestable
rs_addin_r_outdatedRStudio addin for r_outdated() \lifecyclestable
rs_addin_r_vis_drake_graphRStudio addin for r_vis_drake_graph() \lifecyclestable
runningList running targets. \lifecycledeprecated
sankey_drake_graphShow a Sankey graph of your drake project. \lifecyclestable
sankey_drake_graph_implInternal function with a drake_config() argument
sessionsession \lifecycledefunct
shell_fileShell file for Makefile parallelism \lifecycledeprecated
short_hash'drake' now only uses one hash algorithm per cache....
show_sourceShow how a target/import was produced. \lifecyclestable
static_drake_graphDeprecated: show a 'ggraph'/'ggplot2' representation of your...
subtargetsList sub-targets \lifecycleexperimental
summariessummaries \lifecycledefunct
targetCustomize a target in 'drake_plan()'. \lifecyclematuring
target_namespacesStorr namespaces for targets \lifecycledeprecated
text_drake_graphShow a workflow graph as text in your terminal window....
text_drake_graph_implInternal function with a drake_config() argument
this_cacheGet the cache at the exact file path specified....
trackedList the targets and imports that are reproducibly tracked....
transformationsTransformations in 'drake_plan()'. \lifecyclematuring
transform_planTransform a plan \lifecyclematuring
triggerCustomize the decision rules for rebuilding targets...
triggersList the old drake triggers. \lifecycledeprecated
type_sum.expr_listType summary printing \lifecyclestable
use_drakeUse drake in a project \lifecyclequestioning
vis_drake_graphShow an interactive visual network representation of your...
vis_drake_graph_implInternal function with a drake_config() argument
walk_codeStatic code analysis
which_cleanWhich targets will 'clean()' invalidate? \lifecyclematuring
workflowworkflow \lifecycledefunct
workplanworkplan \lifecycledefunct
wlandau-lilly/drake documentation built on March 30, 2020, 5:33 p.m.