-
Notifications
You must be signed in to change notification settings - Fork 83
Expand file tree
/
Copy pathtree.R
More file actions
242 lines (225 loc) · 6.88 KB
/
tree.R
File metadata and controls
242 lines (225 loc) · 6.88 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
#' Draw a tree
#'
#' Draw a tree using box drawing characters. Unicode characters are
#' used if available. (Set the `cli.unicode` option if auto-detection
#' fails.)
#'
#' A node might appear multiple times in the tree, or might not appear
#' at all.
#'
#' @details
#'
#' ```{asciicast, tree}
#' data <- data.frame(
#' stringsAsFactors = FALSE,
#' package = c("processx", "backports", "assertthat", "Matrix",
#' "magrittr", "rprojroot", "clisymbols", "prettyunits", "withr",
#' "desc", "igraph", "R6", "crayon", "debugme", "digest", "irlba",
#' "rcmdcheck", "callr", "pkgconfig", "lattice"),
#' dependencies = I(list(
#' c("assertthat", "crayon", "debugme", "R6"), character(0),
#' character(0), "lattice", character(0), "backports", character(0),
#' c("magrittr", "assertthat"), character(0),
#' c("assertthat", "R6", "crayon", "rprojroot"),
#' c("irlba", "magrittr", "Matrix", "pkgconfig"), character(0),
#' character(0), "crayon", character(0), "Matrix",
#' c("callr", "clisymbols", "crayon", "desc", "digest", "prettyunits",
#' "R6", "rprojroot", "withr"),
#' c("processx", "R6"), character(0), character(0)
#' ))
#' )
#' tree(data)
#' ```
#'
#' ```{asciicast, tree-root}
#' tree(data, root = "rcmdcheck")
#' ```
#'
#' ## Colored nodes
#'
#' ```{asciicast tree-colored}
#' data$label <- paste(data$package,
#' style_dim(paste0("(", c("2.0.0.1", "1.1.1", "0.2.0", "1.2-11",
#' "1.5", "1.2", "1.2.0", "1.0.2", "2.0.0", "1.1.1.9000", "1.1.2",
#' "2.2.2", "1.3.4", "1.0.2", "0.6.12", "2.2.1", "1.2.1.9002",
#' "1.0.0.9000", "2.0.1", "0.20-35"), ")"))
#' )
#' roots <- ! data$package %in% unlist(data$dependencies)
#' data$label[roots] <- col_cyan(style_italic(data$label[roots]))
#' tree(data, root = "rcmdcheck")
#' ```
#'
#' ## Trimming
#'
#' ```{asciicast tree-trimming}
#' pkgdeps <- list(
#' "dplyr@0.8.3" = c("assertthat@0.2.1", "glue@1.3.1", "magrittr@1.5",
#' "R6@2.4.0", "Rcpp@1.0.2", "rlang@0.4.0", "tibble@2.1.3",
#' "tidyselect@0.2.5"),
#' "assertthat@0.2.1" = character(),
#' "glue@1.3.1" = character(),
#' "magrittr@1.5" = character(),
#' "pkgconfig@2.0.3" = character(),
#' "R6@2.4.0" = character(),
#' "Rcpp@1.0.2" = character(),
#' "rlang@0.4.0" = character(),
#' "tibble@2.1.3" = c("cli@1.1.0", "crayon@1.3.4", "fansi@0.4.0",
#' "pillar@1.4.2", "pkgconfig@2.0.3", "rlang@0.4.0"),
#' "cli@1.1.0" = c("assertthat@0.2.1", "crayon@1.3.4"),
#' "crayon@1.3.4" = character(),
#' "fansi@0.4.0" = character(),
#' "pillar@1.4.2" = c("cli@1.1.0", "crayon@1.3.4", "fansi@0.4.0",
#' "rlang@0.4.0", "utf8@1.1.4", "vctrs@0.2.0"),
#' "utf8@1.1.4" = character(),
#' "vctrs@0.2.0" = c("backports@1.1.5", "ellipsis@0.3.0",
#' "digest@0.6.21", "glue@1.3.1", "rlang@0.4.0", "zeallot@0.1.0"),
#' "backports@1.1.5" = character(),
#' "ellipsis@0.3.0" = c("rlang@0.4.0"),
#' "digest@0.6.21" = character(),
#' "glue@1.3.1" = character(),
#' "zeallot@0.1.0" = character(),
#' "tidyselect@0.2.5" = c("glue@1.3.1", "purrr@1.3.1", "rlang@0.4.0",
#' "Rcpp@1.0.2"),
#' "purrr@0.3.3" = c("magrittr@1.5", "rlang@0.4.0")
#' )
#'
#' pkgs <- data.frame(
#' stringsAsFactors = FALSE,
#' name = names(pkgdeps),
#' deps = I(unname(pkgdeps))
#' )
#'
#' tree(pkgs, trim = TRUE)
#' ```
#'
#' ```{asciicast tree-trim-mark}
#' # Mark the trimmed nodes
#' pkgs$label <- pkgs$name
#' pkgs$trimmed <- paste(pkgs$name, " (trimmed)")
#' tree(pkgs, trim = TRUE)
#' ```
#'
#' @param data Data frame that contains the tree structure.
#' The first column is an id, and the second column is a list column,
#' that contains the ids of the child nodes. The optional third column
#' may contain the text to print to annotate the node.
#' @param root The name of the root node.
#' @param style Optional box style list.
#' @param width Maximum width of the output. Defaults to the `width`
#' option, see [base::options()].
#' @param trim Whether to avoid traversing the same nodes multiple times.
#' If `TRUE` and `data` has a `trimmed` column, then that is used for
#' printing repeated nodes.
#' @return Character vector, the lines of the tree drawing.
#'
#' @export
tree <- function(
data,
root = data[[1]][[1]],
style = NULL,
width = console_width(),
trim = FALSE
) {
stopifnot(
is.data.frame(data),
ncol(data) >= 2,
is_string(root),
is.null(style) || (is_tree_style(style)),
is_count(width)
)
style <- style %||% box_chars()
labels <- if (ncol(data) >= 3) data[[3]] else data[[1]]
trimlabs <- data[["trimmed"]] %||% labels
seen <- character()
res <- character()
pt <- function(root, n = integer(), mx = integer(), used = character()) {
num_root <- match(root, data[[1]])
if (is.na(num_root)) return()
prefix <- vcapply(seq_along(n), function(i) {
if (n[i] < mx[i]) {
if (i == length(n)) {
paste0(style$j, style$h)
} else {
paste0(style$v, " ")
}
} else if (n[i] == mx[i] && i == length(n)) {
paste0(style$l, style$h)
} else {
" "
}
})
root_seen <- root %in% seen
root_lab <- if (trim && root_seen) trimlabs[[num_root]] else
labels[[num_root]]
# multi-line labels
prefix2 <- if (grepl("\n", root_lab, fixed = TRUE)) {
root_lab <- ansi_strsplit(root_lab, "\n", fixed = TRUE)[[1]]
vcapply(seq_along(n), function(i) {
if (n[i] < mx[i]) {
if (i == length(n)) {
paste0(style$v, " ")
} else {
paste0(style$v, " ")
}
} else if (n[i] == mx[i] && i == length(n)) {
" "
} else {
" "
}
})
}
res <<- c(
res,
paste0(
c(
paste(prefix, collapse = ""),
if (length(root_lab) > 1) {
rep(paste(prefix2, collapse = ""), length(root_lab) - 1)
}
),
root_lab
)
)
# Detect infinite loops
if (!trim && root %in% used) {
warning(
call. = FALSE,
"Endless loop found in tree: ",
paste0(c(used, root), collapse = " -> ")
)
} else if (!trim || !root_seen) {
seen <<- c(seen, root)
children <- data[[2]][[num_root]]
for (d in seq_along(children)) {
pt(children[[d]], c(n, d), c(mx, length(children)), c(used, root))
}
}
}
if (nrow(data)) pt(root)
res <- ansi_substr(res, 1, width)
class(res) <- unique(c("cli_tree", "tree", class(res), "character"))
res
}
box_chars <- function() {
if (is_utf8_output()) {
list(
"h" = "\u2500", # horizontal
"v" = "\u2502", # vertical
"l" = "\u2514", # leaf
"j" = "\u251C" # junction
)
} else {
list(
"h" = "-", # horizontal
"v" = "|", # vertical
"l" = "\\", # leaf
"j" = "+" # junction
)
}
}
methods::setOldClass(c("cli_tree", "character"))
#' @export
print.cli_tree <- function(x, ..., sep = "\n") {
cat(x, ..., sep = sep)
invisible(x)
}