Man pages for wlandau-lilly/drake
A Pipeline Toolkit for Reproducible Computation at Scale
| analyses | analyses *[Defunct]* |
| analysis_wildcard | Show the analysis wildcard used in 'plan_summaries()'.... |
| as_drake_filename | as_drake_filename *[Defunct]* |
| as_file | as_file *[Defunct]* |
| available_hash_algos | List the available hash algorithms for drake caches.... |
| backend | backend *[Defunct]* |
| bind_plans | Row-bind together drake plans *[Stable]* |
| build_drake_graph | Function 'build_drake_graph' *[Deprecated]* |
| build_graph | build_graph *[Defunct]* |
| build_times | See the time it took to build each target. *[Stable]* |
| built | List all the built targets (non-imports) in the cache.... |
| cached | List targets in the cache. *[Stable]* |
| cached_planned | List targets in both the plan and the cache. *[Stable]* |
| cached_unplanned | List targets in the cache but not the plan. *[Stable]* |
| cache_namespaces | List all the 'storr' cache namespaces used by drake.... |
| cache_path | Return the file path where the cache is stored, if... |
| cancel | Cancel a target mid-build *[Stable]* |
| cancel_if | Cancel a target mid-build under some condition *[Stable]* |
| check | check *[Defunct]* |
| check_plan | Check a workflow plan data frame for obvious errors.... |
| clean | Invalidate and deregister targets. *[Stable]* |
| cleaned_namespaces | Auxiliary storr namespaces *[Deprecated]* |
| clean_main_example | Deprecated: clean the main example from... |
| clean_mtcars_example | Clean the mtcars example from 'drake_example("mtcars")'... |
| cmq_build | Build a target using the clustermq backend *[Stable]* |
| code_to_function | Turn a script into a function. *[Stable]* |
| code_to_plan | Turn an R script file or 'knitr' / R Markdown report into a... |
| config | config *[Defunct]* |
| configure_cache | Configure the hash algorithms, etc. of a drake cache.... |
| dataframes_graph | dataframes_graph *[Defunct]* |
| dataset_wildcard | Show the dataset wildcard used in 'plan_analyses()' and... |
| debug_and_run | Run a function in debug mode. *[Stable]* |
| default_graph_title | Return the default title for graph visualizations... |
| default_long_hash_algo | Return the default long hash algorithm for 'make()'.... |
| default_Makefile_args | Default arguments of Makefile parallelism *[Deprecated]* |
| default_Makefile_command | Default Makefile command *[Deprecated]* |
| default_parallelism | Default parallel backend *[Deprecated]* |
| default_recipe_command | Default Makefile recipe command *[Deprecated]* |
| default_short_hash_algo | Return the default short hash algorithm for 'make()'.... |
| default_system2_args | default_system2_args *[Defunct]* |
| default_verbose | Default verbosity *[Deprecated]* |
| dependency_profile | States of the dependencies of a target *[Deprecated]* |
| deprecate_wildcard | deprecate_wildcard *[Defunct]* |
| deps | deps *[Defunct]* |
| deps_code | List the dependencies of a function or command *[Stable]* |
| deps_knitr | Find the drake dependencies of a dynamic knitr report target.... |
| deps_profile | Find out why a target is out of date. *[Stable]* |
| deps_profile_impl | Internal function with a drake_config() argument |
| deps_target | List the dependencies of a target *[Stable]* |
| deps_target_impl | Internal function with a drake_config() argument |
| deps_targets | See the dependencies of a target *[Deprecated]* |
| diagnose | Get diagnostic metadata on a target. *[Stable]* |
| doc_of_function_call | doc_of_function_call *[Defunct]* |
| do_prework | Do the prework in the 'prework' argument to 'make()'.... |
| drake_batchtools_tmpl_file | Get a template file for execution on a cluster.... |
| drake_build | Build/process a single target or import. *[Questioning]* |
| drake_build_impl | Internal function with a drake_config() argument |
| drake_cache | Get the cache of a 'drake' project. *[Stable]* |
| drake_cache_log | Get the state of the cache. *[Stable]* |
| drake_cache_log_file | Generate a flat text log file to represent the state of the... |
| drake_cancelled | List cancelled targets. *[Stable]* |
| drake_config | Ending of _drake.R for r_make() and friends *[Stable]* |
| drake_debug | Run a single target's command in debug mode.' *[Questioning]* |
| drake_deps | 'drake_deps' helper |
| drake_deps_ht | 'drake_deps_ht' helper |
| drake_done | List done targets. *[Stable]* |
| drake_envir | Get the environment where drake builds targets... |
| drake_example | Download the files of an example 'drake' project. *[Stable]* |
| drake_examples | List the names of all the drake examples. *[Stable]* |
| drake_failed | List failed targets. *[Stable]* |
| drake_gc | Do garbage collection on the drake cache. *[Stable]* |
| drake_get_session_info | Session info of the last call to 'make()'. *[Stable]* |
| drake_ggraph | Visualize the workflow with 'ggraph'/'ggplot2' *[Stable]* |
| drake_ggraph_impl | Internal function with a drake_config() argument |
| drake_graph_info | Prepare the workflow graph for visualization *[Stable]* |
| drake_graph_info_impl | Internal function |
| drake_history | History and provenance *[Stable]* |
| drake_hpc_template_file | Write a template file for deploying work to a cluster / job... |
| drake_hpc_template_files | List the available example template files for deploying work... |
| drake_meta | Compute the initial pre-build metadata of a target or import.... |
| drake-package | drake: A pipeline toolkit for reproducible computation at... |
| drake_palette | Show drake's color palette. *[Deprecated]* |
| drake_plan | Create a drake plan for the 'plan' argument of 'make()'.... |
| drake_plan_source | Show the code required to produce a given 'drake' plan... |
| drake_progress | Get the build progress of your targets *[Stable]* |
| drake_quotes | Put quotes around each element of a character vector.... |
| drake_running | List running targets. *[Stable]* |
| drake_script | Write an example _drake.R script to the current working... |
| drake_session | Session info of the last call to 'make()'. *[Deprecated]* |
| drake_settings | 'drake_settings' helper |
| drake_slice | Take a strategic subset of a dataset. *[Stable]* |
| drake_strings | Turn valid expressions into character strings. *[Deprecated]* |
| drake_tempfile | drake tempfile *[Stable]* |
| drake_tip | Output a random tip about drake. *[Deprecated]* |
| drake_triggers | 'drake_triggers' helper |
| drake_unquote | Remove leading and trailing escaped quotes from character... |
| evaluate | evaluate *[Defunct]* |
| evaluate_plan | Use wildcard templating to create a workflow plan data frame... |
| example_drake | example_drake *[Defunct]* |
| examples_drake | examples_drake *[Defunct]* |
| expand | expand *[Defunct]* |
| expand_plan | Deprecated: create replicates of targets. *[Deprecated]* |
| expose_imports | Deprecated: expose package functions and objects for analysis... |
| failed | List failed targets. *[Deprecated]* |
| file_in | Declare input files and directories. *[Stable]* |
| file_out | Declare output files and directories. *[Stable]* |
| file_store | Show a file's encoded representation in the cache *[Stable]* |
| find_cache | Search up the file system for the nearest drake cache.... |
| find_knitr_doc | find_knitr_doc *[Defunct]* |
| find_project | Search up the file system for the nearest root path of a... |
| from_plan | from_plan *[Defunct]* |
| future_build | Task passed to individual futures in the '"future"' backend... |
| gather | gather *[Defunct]* |
| gather_by | Gather multiple groupings of targets *[Deprecated]* |
| gather_plan | Combine targets *[Deprecated]* |
| get_cache | The default cache of a 'drake' project. *[Deprecated]* |
| get_trace | Deprecated, get a trace of a dynamic target's value.... |
| id_chr | Name of the current target *[Stable]* |
| ignore | Ignore code *[Stable]* |
| imported | List all the imports in the drake cache. *[Deprecated]* |
| in_progress | List the targets in progress *[Deprecated]* |
| is_function_call | is_function_call *[Defunct]* |
| isolate_example | Isolate the side effects of an example. *[Stable]* |
| knitr_deps | Dependencies of a knitr report *[Deprecated]* |
| knitr_in | Declare 'knitr'/'rmarkdown' source files as dependencies.... |
| legend_nodes | Create the nodes data frame used in the legend of the graph... |
| load_basic_example | load_basic_example *[Defunct]* |
| load_main_example | Load the main example. *[Deprecated]* |
| load_mtcars_example | Load the mtcars example. *[Stable]* |
| long_hash | 'drake' now has just one hash algorithm per cache.... |
| make | Run your project (build the outdated targets). *[Stable]* |
| Makefile_recipe | Default Makefile recipe *[Deprecated]* |
| make_impl | Internal function with a drake_config() argument |
| make_imports | Just process the imports *[Deprecated]* |
| make_targets | Just make the targets *[Deprecated]* |
| make_with_config | Apply make() with a pre-computed config object *[Deprecated]* |
| manage_memory | Manage the in-memory dependencies of a target. *[Stable]* |
| map_plan | Create a plan that maps a function to a grid of arguments.... |
| max_useful_jobs | max_useful_jobs *[Defunct]* |
| migrate_drake_project | migrate_drake_project *[Defunct]* |
| missed | Report any import objects required by your drake_plan plan... |
| missed_impl | Internal function with a drake_config() argument |
| new_cache | Make a new 'drake' cache. *[Stable]* |
| 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_deps | Suppress dependency detection. *[Stable]* |
| outdated | List the targets that are out of date. *[Stable]* |
| outdated_impl | Internal function with a drake_config() argument |
| parallelism_choices | Names of old parallel backends *[Deprecated]* |
| parallel_stages | parallel_stages *[Defunct]* |
| plan | plan *[Defunct]* |
| plan_analyses | Specialized wildcard for analyses *[Deprecated]* |
| plan_drake | plan_drake *[Defunct]* |
| plan_summaries | Specialized wildcard for summaries *[Deprecated]* |
| plan_to_code | Turn a 'drake' plan into a plain R script file.... |
| plan_to_notebook | Turn a 'drake' plan into an R notebook. *[Questioning]* |
| plot_graph | plot_graph *[Defunct]* |
| predict_load_balancing | Predict parallel computing behavior *[Deprecated]* |
| predict_runtime | Predict the elapsed runtime of the next call to 'make()' for... |
| predict_runtime_impl | Internal function with a drake_config() argument |
| predict_workers | Predict the load balancing of the next call to 'make()' for... |
| predict_workers_impl | Internal function with a drake_config() argument |
| process_import | Process an imported data object *[Stable]* |
| progress | Get the build progress of your targets *[Deprecated]* |
| prune_drake_graph | Prune the graph *[Deprecated]* |
| rate_limiting_times | rate_limiting_times *[Defunct]* |
| read_config | read_config *[Defunct]* |
| readd | Read and return a drake target/import from the cache.... |
| read_drake_config | Read a config object from the cache *[Deprecated]* |
| read_drake_graph | Read a workflow graph from the cache *[Deprecated]* |
| read_drake_meta | read_drake_meta *[Defunct]* |
| read_drake_plan | Read the plan from the cache *[Deprecated]* |
| read_drake_seed | Read the pseudo-random number generator seed of the project.... |
| read_graph | read_graph *[Defunct]* |
| read_plan | read_plan *[Defunct]* |
| read_trace | Read a trace of a dynamic target. *[Stable]* |
| recoverable | List the most upstream _recoverable_ outdated targets.... |
| recoverable_impl | Internal function with a drake_config() argument |
| recover_cache | Load or create a drake cache *[Deprecated]* |
| reduce_by | Reduce multiple groupings of targets *[Deprecated]* |
| reduce_plan | Write commands to reduce several targets down to one.... |
| reexports | Objects exported from other packages |
| render_drake_ggraph | Visualize the workflow with 'ggplot2'/'ggraph' using... |
| render_drake_graph | Render a visualization using the data frames generated by... |
| render_graph | render_graph *[Defunct]* |
| render_sankey_drake_graph | Render a Sankey diagram from 'drake_graph_info()'. *[Stable]* |
| render_static_drake_graph | Deprecated: render a 'ggraph'/'ggplot2' representation of... |
| render_text_drake_graph | Show a workflow graph as text in your terminal window using... |
| rescue_cache | Try to repair a drake cache that is prone to throwing... |
| r_make | Launch a drake function in a fresh new R process *[Stable]* |
| r_recipe_wildcard | Default Makefile recipe wildcard *[Deprecated]* |
| rs_addin_loadd | Loadd target at cursor into global environment *[Stable]* |
| rs_addin_r_make | RStudio addin for r_make() *[Stable]* |
| rs_addin_r_outdated | RStudio addin for r_outdated() *[Stable]* |
| rs_addin_r_vis_drake_graph | RStudio addin for r_vis_drake_graph() *[Stable]* |
| running | List running targets. *[Deprecated]* |
| sankey_drake_graph | Show a Sankey graph of your drake project. *[Stable]* |
| sankey_drake_graph_impl | Internal function with a drake_config() argument |
| session | session *[Defunct]* |
| shell_file | Shell file for Makefile parallelism *[Deprecated]* |
| short_hash | 'drake' now only uses one hash algorithm per cache.... |
| show_source | Show how a target/import was produced. *[Stable]* |
| static_drake_graph | Deprecated: show a 'ggraph'/'ggplot2' representation of your... |
| subtargets | List sub-targets *[Stable]* |
| summaries | summaries *[Defunct]* |
| target | Customize a target in 'drake_plan()'. *[Stable]* |
| target_namespaces | Storr namespaces for targets *[Deprecated]* |
| text_drake_graph | Show a workflow graph as text in your terminal window.... |
| text_drake_graph_impl | Internal function with a drake_config() argument |
| this_cache | Get the cache at the exact file path specified.... |
| tracked | List the targets and imports that are reproducibly tracked.... |
| transformations | Transformations in 'drake_plan()'. *[Stable]* |
| transform_plan | Transform a plan *[Stable]* |
| trigger | Customize the decision rules for rebuilding targets... |
| triggers | List the old drake triggers. *[Deprecated]* |
| type_sum.expr_list | Type summary printing *[Questioning]* |
| use_drake | Use drake in a project *[Questioning]* |
| vis_drake_graph | Show an interactive visual network representation of your... |
| vis_drake_graph_impl | Internal function with a drake_config() argument |
| walk_code | Static code analysis |
| which_clean | Which targets will 'clean()' invalidate? *[Stable]* |
| workflow | workflow *[Defunct]* |
| workplan | workplan *[Defunct]* |
