Skip to content

Commit

Permalink
Add remaining badges
Browse files Browse the repository at this point in the history
  • Loading branch information
wlandau committed Aug 13, 2019
1 parent acdd36c commit 792dbe0
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 11 deletions.
3 changes: 3 additions & 0 deletions R/clean.R
@@ -1,4 +1,5 @@
#' @title Invalidate and deregister targets.
#' \lifecycle{maturing}
#' @description Force targets to be out of date and remove target names
#' from the data in the cache.
#' @details By default, [clean()] invalidates **all** targets,
Expand Down Expand Up @@ -224,6 +225,7 @@ abort_gc <- function(path) {
}

#' @title Do garbage collection on the drake cache.
#' \lifecycle{maturing}
#' @description Garbage collection removes obsolete target values
#' from the cache.
#' @details Caution: garbage collection *actually* removes data
Expand Down Expand Up @@ -283,6 +285,7 @@ keys_are_mangled <- function(cache) {

#' @title Try to repair a drake cache that is prone
#' to throwing `storr`-related errors.
#' \lifecycle{questioning}
#' @description Sometimes, `storr` caches may have
#' dangling orphaned files that prevent you from loading or cleaning.
#' This function tries to remove those files so you can use the
Expand Down
9 changes: 5 additions & 4 deletions R/text_drake_graph.R
@@ -1,5 +1,5 @@
#' @title Use text art to show a visual representation of
#' your workflow's dependency graph in your terminal window.
#' @title Show a workflow graph as text in your terminal window.
#' \lifecycle{stable}
#' @description This is a low-tech version of [vis_drake_graph()]
#' and friends. It is designed for when you do not have access
#' to the usual graphics devices for viewing visuals in an interactive
Expand Down Expand Up @@ -71,8 +71,9 @@ text_drake_graph <- function(
)
}

#' @title Render a text-based visualization of drake's dependency graph
#' using the data frames generated by [drake_graph_info()].
#' @title Show a workflow graph as text in your terminal window
#' using [drake_graph_info()] output.
#' \lifecycle{stable}
#' @description This function is called inside
#' [text_drake_graph()], which typical users
#' call more often. See `?text_drake_graph` for details.
Expand Down
1 change: 1 addition & 0 deletions inst/WORDLIST
Expand Up @@ -245,6 +245,7 @@ widehat
withTimeout
wlandau
workflowr
workplan
YAML
Yub
zeromq
Expand Down
3 changes: 2 additions & 1 deletion man/clean.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/drake_gc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions man/render_text_drake_graph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion man/rescue_cache.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/text_drake_graph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 792dbe0

Please sign in to comment.