Man pages for ropensci/drake
A Pipeline Toolkit for Reproducible Computation at Scale

analysesDeprecated function 'analyses'
analysis_wildcardShow the analysis wildcard used in 'plan_summaries()'.
as_drake_filenameDeprecated function 'as_drake_filename'
as_fileDeprecated function 'as_file'
available_hash_algosList the available hash algorithms for drake caches.
backendDeprecated function 'backend'
bind_plansRow-bind together drake plans
blitz_buildBuild a target using "blitz" parallelism
build_drake_graphCreate the 'igraph' dependency network of your project.
build_graphDeprecated function 'build_graph'
build_timesList the time it took to build each target/import.
builtList all the built targets (non-imports) in the cache.
cachedEnumerate cached targets or check if a target is cached.
cache_namespacesList all the 'storr' cache namespaces used by drake.
cache_pathReturn the file path where the cache is stored, if...
checkDeprecated function 'check'
check_planCheck a workflow plan data frame for obvious errors.
cleanRemove targets/imports from the cache.
cleaned_namespacesFor drake caches, list the 'storr' namespaces that are...
clean_main_exampleClean the main example from 'drake_example("main")'
clean_mtcars_exampleClean the mtcars example from 'drake_example("mtcars")'
cmq_buildBuild a target using the clustermq backend
cmq_staged_buildBuild a target using the clustermq_staged backend
code_to_planTurn an R script file or knitr / R Markdown report into a...
configDeprecated function 'config'
configure_cacheConfigure the hash algorithms, etc. of a drake cache.
dataframes_graphDeprecated function 'dataframes_graph'
dataset_wildcardShow the dataset wildcard used in 'plan_analyses()' and...
debug_and_runRun a function in debug mode.
default_cache_pathReturn the default file path of the drake/storr cache.
default_graph_titleReturn the default title for graph visualizations
default_hookDefault 'hook' argument to 'make()'.
default_long_hash_algoReturn the default long hash algorithm for 'make()'.
default_Makefile_argsReturn the default value of the 'args' argument to 'make()'.
default_Makefile_commandGive the default 'command' argument to 'make()'.
default_parallelismShow the default 'parallelism' argument to 'make()' for your...
default_recipe_commandShow the default recipe command for 'make(..., parallelism =...
default_short_hash_algoReturn the default short hash algorithm for 'make()'.
default_system2_argsDeprecated function 'default_system2_args'
default_verboseDefault verbosity for 'drake'
dependency_profileFind out why a target is out of date.
depsDeprecated. List the dependencies of a function, workflow...
deps_codeList the dependencies of a function, workflow plan command,...
deps_targetList the dependencies of one or more targets
deps_targetsDeprecated.
diagnoseGet diagnostic metadata on a target.
do_preworkDo the prework in the 'prework' argument to 'make()'.
drake_batchtools_tmpl_fileDeprecated. Get a template file for execution on a cluster.
drake_buildBuild/process a single target or import.
drake_cache_logGet a table that represents the state of the cache.
drake_cache_log_fileGenerate a flat text log file to represent the state of the...
drake_configCreate the internal runtime parameter list used internally in...
drake_debugRun a single target's command in debug mode.
drake_exampleDownload and save the code and data files of an example...
drake_examplesList the names of all the drake examples.
drake_future_taskTask passed to individual futures in the '"future"' backend
drake_gcDo garbage collection on the drake cache.
drake_ggraphShow a 'ggraph'/'ggplot2' representation of your drake...
drake_graph_infoCreate the underlying node and edge data frames behind...
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 is a pipeline toolkit (<URL:...
drake_paletteShow drake's color palette.
drake_planCreate a workflow plan data frame for the 'plan' argument of...
drake_plan_sourceShow the code required to produce a given workflow plan data...
drake_quotesPut quotes around each element of a character vector.
drake_sessionReturn the 'sessionInfo()' of the last call to 'make()'.
drake_stringsTurn valid expressions into character strings.
drake_tipOutput a random tip about drake.
drake_unquoteRemove leading and trailing escaped quotes from character...
eager_load_targetLoad a target right away (internal function)
empty_hookA 'hook' argument to 'make()' for which no targets get built...
evaluateDeprecated function 'evaluate'
evaluate_planUse wildcard templating to create a workflow plan data frame...
example_drakeDeprecated function 'example_drake'
examples_drakeDeprecated function 'examples_drake'
expandDeprecated function 'expand'
expand_planCreate replicates of targets.
expose_importsExpose all the imports in a package so 'make()' can detect...
failedList the targets that failed in the last call to 'make()'.
file_inDeclare the file inputs of a workflow plan command.
file_outDeclare the file outputs of a workflow plan command.
file_storeTell 'drake' that you want information on a _file_ (target or...
find_cacheSearch up the file system for the nearest drake cache.
find_projectSearch up the file system for the nearest root path of a...
fl_masterRun the master process of the "future_lapply" backend.
gatherDeprecated function 'gather'
gather_byGather multiple groupings of targets
gather_planWrite commands to combine several targets into one or more...
get_cacheGet the drake cache, optionally searching up the file system.
ignoreIgnore components of commands and imported functions.
importedList all the imports in the drake cache.
in_progressList the targets that either (1) are currently being built...
knitr_depsFind the drake dependencies of a dynamic knitr report target.
knitr_inDeclare the 'knitr'/'rmarkdown' source files of a workflow...
legend_nodesCreate the nodes data frame used in the legend of the graph...
load_basic_exampleDeprecated function 'load_basic_example'
load_main_exampleLoad the main example from 'drake_example("main")'
load_mtcars_exampleLoad the mtcars example from 'drake_example("mtcars")'
long_hashGet the long hash algorithm of a drake cache.
makeRun your project (build the outdated targets).
Makefile_recipeFor 'make(..., parallelism = "Makefile")', see what your...
make_importsJust make the imports.
make_sessionInternal function to be called by 'make_with_config()'
make_targetsJust build the targets.
make_with_configRun 'make()', on an existing internal configuration list.
map_planCreate a plan that maps a function to a grid of arguments.
max_useful_jobsDeprecated function
mc_masterInternal function to launch a master process.
mc_processInternal function to launch a master process or persistent...
message_sink_hookAn example 'hook' argument to 'make()' that redirects error...
migrate_drake_projectDeprecated: reconfigure an old project (built with drake <=...
missedReport any import objects required by your drake_plan plan...
mkBuild a target inside a 'Makefile' during 'make(...,...
new_cacheMake a new 'drake' cache.
outdatedList the targets that are out of date.
output_sink_hookAn example 'hook' argument to 'make()' that redirects output...
parallelism_choicesList the types of supported parallel computing in drake.
parallel_stagesDefunct function
planDeprecated function 'plan'
plan_analysesGenerate a workflow plan data frame to analyze multiple...
plan_drakeDeprecated function 'plan_drake'
plan_summariesGenerate a workflow plan data frame for summarizing multiple...
plan_to_codeTurn a 'drake' workflow plan data frame into a plain R script...
plan_to_notebookTurn a 'drake' workflow plan data frame into an R notebook,
plot_graphDeprecated function 'plot_graph'
predict_load_balancingPredict the load balancing of the next call to 'make()' for...
predict_runtimePredict the elapsed runtime of the next call to 'make()' for...
prepare_distributedDo the preparatory work for 'make()' with a distributed...
progressGet the build progress of your targets during a 'make()'.
prune_drake_graphPrune the dependency network of your project.
prune_envirPrune the evaluation environment
rate_limiting_timesDefunct
read_configDeprecated function 'read_config'
readdRead and return a drake target/import from the cache.
read_drake_configRead the cached 'drake_config()' list from the last 'make()'.
read_drake_graphRead the igraph dependency network from your last attempted...
read_drake_metaDeprecated: read the metadata of a target or import.
read_drake_planRead the workflow plan from your last attempted call to...
read_drake_seedRead the pseudo-random number generator seed of the project.
read_graphDeprecated function 'read_graph'
read_planDeprecated function 'read_plan'
recover_cacheLoad an existing drake files system cache if it exists or...
reduce_byReduce multiple groupings of targets
reduce_planWrite commands to reduce several targets down to one.
reexportsObjects exported from other packages
render_drake_ggraphRender a static 'ggplot2'/'ggraph' visualization from...
render_drake_graphRender a visualization using the data frames generated by...
render_graphDeprecated function 'render_graph'
render_sankey_drake_graphRender a Sankey diagram from'drake_graph_info()'.
render_static_drake_graphDeprecated: render a 'ggraph'/'ggplot2' representation of...
rescue_cacheTry to repair a drake cache that is prone to throwing...
r_recipe_wildcardShow the R recipe wildcard for 'make(..., parallelism =...
sankey_drake_graphShow a Sankey graph of your drake project.
sessionDeprecated function 'session'
shell_fileWrite an example 'shell.sh' file required by 'make(...,...
short_hashGet the short hash algorithm of a drake cache.
show_sourceShow how a target/import was produced.
silencer_hookAn example 'hook' argument to 'make()' that redirects output...
static_drake_graphDeprecated: show a 'ggraph'/'ggplot2' representation of your...
store_drake_configStore an internal configuration list from 'drake_config()'.
summariesDeprecated function 'summaries'
targetDefine custom columns in a 'drake_plan()'.
target_namespacesFor drake caches, list the 'storr' cache namespaces that...
test_with_dirRun a unit test in a way that quarantines the side effects...
this_cacheGet the cache at the exact file path specified.
time_stampsWrite dummy timestamp files for 'make(..., parallelism =...
trackedList the targets and imports that are reproducibly tracked.
triggerCustomize the decision rules for rebuilding targets
triggersDeprecated. List the old drake triggers.
vis_drake_graphShow an interactive visual network representation of your...
workflowDeprecated function 'workflow'
workplanDeprecated function 'workplan'
ropensci/drake documentation built on Oct. 23, 2018, 1:28 a.m.