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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
|
#' @rdname ggraph
#' @aliases layout_tbl_graph
#'
#' @importFrom igraph gorder
#' @export
#'
create_layout.tbl_graph <- function(graph, layout, circular = FALSE, ...) {
graph <- mutate(ungroup(activate(graph, 'nodes')), .ggraph.orig_index = seq_len(graph_order()))
graph <- prepare_graph(graph, layout, ...)
.register_graph_context(graph, free = TRUE)
if (gorder(graph) == 0) {
layout <- data_frame0(x = numeric(), y = numeric(), circular = logical(), .N())
} else {
layout <- layout_to_table(layout, graph, circular = circular, ...)
}
layout$.ggraph.index <- seq_len(nrow(layout))
if (is.null(attr(layout, 'graph'))) {
attr(layout, 'graph') <- graph
}
attr(layout, 'circular') <- circular
class(layout) <- c(
'layout_tbl_graph',
'layout_ggraph',
'data.frame'
)
check_layout(layout)
}
collect_edges.layout_tbl_graph <- function(layout) {
gr <- attr(layout, 'graph')
edges <- as_tibble(gr, active = 'edges')
edges$circular <- rep(attr(layout, 'circular'), nrow(edges))
data_frame0(edges)
}
#' @importFrom igraph shortest_paths
#' @importFrom rlang enquo eval_tidy
collect_connections.layout_tbl_graph <- function(layout, from, to, weight = NULL, mode = 'all') {
from <- match(from, layout$.ggraph.orig_index)
to <- match(to, layout$.ggraph.orig_index)
weight <- eval_tidy(enquo(weight), collect_edges(layout))
if (is.null(weight)) {
weight <- NA
}
graph <- attr(layout, 'graph')
to_ind <- split(seq_along(to), from)
connections <- lapply(seq_along(to_ind), function(i) {
paths <- shortest_paths(graph, as.integer(names(to_ind)[i]), to[to_ind[[i]]], mode = mode, weights = weight)$vpath
lapply(paths, as.numeric)
})
connections <- unlist(connections, recursive = FALSE)
connections[match(seq_along(to), unlist(to_ind))]
}
# HELPERS -----------------------------------------------------------------
is.igraphlayout <- function(type) {
if (type %in% igraphlayouts) {
TRUE
} else if (any(paste0(c('as_', 'in_', 'with_', 'on_'), type) %in% igraphlayouts)) {
TRUE
} else {
FALSE
}
}
as.igraphlayout <- function(type, call = caller_env()) {
if (type %in% igraphlayouts) {
layout <- type
} else {
new_type <- paste0(c('as_', 'in_', 'with_', 'on_'), type)
type_ind <- which(new_type %in% igraphlayouts)
if (length(type_ind) == 0) {
cli::cli_abort('Cannot find the igraph layout {.val {type}}', call = call)
}
layout <- new_type[type_ind]
}
paste0('layout_', layout)
}
#' @importFrom igraph gorder permute
prepare_graph <- function(graph, layout, direction = 'out', ...) {
if (!is.character(layout)) {
return(graph)
}
is_hierarchy <- layout %in% c(
'dendrogram',
'treemap',
'circlepack',
'partition'
)
if (is_hierarchy || (layout == 'auto' && with_graph(graph, graph_is_tree() || graph_is_forest()))) {
graph <- graph_to_tree(graph, mode = direction)
graph <- permute(graph, match(seq_len(gorder(graph)), order(node_depth(graph, direction))))
}
as_tbl_graph(graph)
}
#' @importFrom igraph degree unfold_tree components induced_subgraph vertex_attr vertex_attr<- is.directed simplify
graph_to_tree <- function(graph, mode) {
if (!is.directed(graph)) {
cli::cli_abort('{.arg graph} must be directed')
}
graph <- simplify(graph, edge.attr.comb = 'first')
parent_dir <- if (mode == 'out') 'in' else 'out'
comp <- components(graph, 'weak')
graphs <- lapply(seq_len(comp$no), function(i) {
graph <- induced_subgraph(graph, which(comp$membership == i))
n_parents <- degree(graph, mode = parent_dir)
if (!any(n_parents == 0)) {
cli::cli_abort(c(
'{.arg graph} doesn\'t contain a root.',
i = ' Provide graph with one parentless node'
))
}
if (any(n_parents > 1)) {
cli::cli_inform('Multiple parents. Unfolding graph')
root <- which(degree(graph, mode = parent_dir) == 0)
if (length(root) > 1) {
cli::cli_inform('Multiple roots in graph. Choosing the first')
root <- root[1]
}
tree <- unfold_tree(graph, mode = mode, roots = root)
vattr <- lapply(vertex_attr(graph), `[`, i = tree$vertex_index)
vertex_attr(tree$tree) <- vattr
graph <- tree$tree
}
as_tbl_graph(graph)
})
inject(bind_graphs(!!!graphs))
}
#' @importFrom igraph gorder as_edgelist delete_vertex_attr is.named
tree_to_hierarchy <- function(graph, mode, sort.by, weight, height = NULL) {
if (is.named(graph)) graph <- delete_vertex_attr(graph, 'name')
parent_col <- if (mode == 'out') 1 else 2
node_col <- if (mode == 'out') 2 else 1
edges <- as_edgelist(graph)
hierarchy <- data_frame0(parent = rep(0, gorder(graph)))
hierarchy$parent[edges[, node_col]] <- edges[, parent_col]
if (is.null(sort.by)) {
hierarchy$order <- seq_len(nrow(hierarchy)) + 1
} else {
hierarchy$order <- order(sort.by) + 1
}
if (is.null(height)) {
hierarchy$height <- 1
} else {
hierarchy$height <- 0
hierarchy$height[edges[, node_col]] <- height
}
leaf <- degree(graph, mode = mode) == 0
if (is.null(weight)) {
hierarchy$weight <- 0
hierarchy$weight[leaf] <- 1
} else {
if (!is.numeric(weight)) {
cli::cli_abort('{.arg weight} must be numeric')
}
hierarchy$weight <- weight
if (any(hierarchy$weight[!leaf] != 0)) {
cli::cli_inform('Non-leaf weights ignored')
}
if (any(hierarchy$weight[leaf] == 0)) {
cli::cli_abort('leaf nodes must have a weight')
}
hierarchy$weight[!leaf] <- 0
}
hierarchy <- hierarchy[c(1, seq_len(nrow(hierarchy))), ]
hierarchy$parent[1] <- -1
hierarchy$order[1] <- 1
hierarchy
}
#' @importFrom igraph bfs degree gorder
node_depth <- function(graph, mode) {
mode_rev <- switch(
mode,
`in` = 'out',
out = 'in',
cli::cli_abort(c(
'Unknown graph mode {.val {mode}}',
i = "use either {.val in} or {.val out}"
))
)
root <- which(degree(graph, mode = mode_rev) == 0)
depth <- rep(NA_integer_, gorder(graph))
for (i in root) {
depth[!is.finite(depth)] <- unname(bfs(graph, root = i, unreachable = FALSE, dist = TRUE)$dist)[!is.finite(depth)]
}
depth
}
#' @importFrom rlang .data
add_direction <- function(graph, pos, direction = 'out') {
if (igraph::gsize(graph) == 0) {
return(graph)
}
graph <- activate(graph, 'edges')
graph <- mutate(graph, direction = ifelse(pos$x[.data$to] < pos$x[.data$from], 'right', 'left'))
if (direction == 'in') {
graph <- mutate(graph, ifelse(.data$direction == 'left', 'right', 'left'))
}
graph <- mutate(graph, direction = factor(.data$direction))
graph
}
#' Convert a layout to a table
#'
#' This generic takes care of dispatching various layout types (names,
#' functions, tables) to their respective functions that will return a valid
#' layout table.
#'
#' @param layout A supported object
#' @param graph A `tbl_graph`
#' @param ... passed on to implementations
#'
#' @return A valid data.frame
#'
#' @keywords internal
#' @export
layout_to_table <- function(layout, graph, ...) {
UseMethod('layout_to_table')
}
#' @export
layout_to_table.default <- function(layout, graph, ...) {
cli::cli_abort('Unknown {.arg layout}')
}
#' @export
layout_to_table.character <- function(layout, graph, circular, ...) {
if (is.igraphlayout(layout)) {
layout_tbl_graph_igraph(graph, layout, circular, ...)
} else {
layout_fun <- get(paste0('layout_tbl_graph_', layout))
layout_fun(graph, circular = circular, ...)
}
}
#' @export
layout_to_table.matrix <- function(layout, graph, ...) {
layout <- data_frame0(x = layout[, 1], y = layout[, 2])
layout_to_table(layout, graph, ...)
}
#' @export
layout_to_table.data.frame <- function(layout, graph, ...) {
combine_layout_nodes(layout, as_tibble(graph, active = 'nodes'))
}
#' @export
layout_to_table.function <- function(layout, graph, circular, ...) {
layout <- if ('circular' %in% names(formals(layout))) {
layout(graph, circular = circular, ...)
} else {
layout(graph, ...)
}
if (!is.tbl_graph(layout) && !is.data.frame(layout)) {
layout <- try_fetch(
data_frame0(layout),
error = function(e) {
try_fetch(
as_tbl_graph(layout),
error = function(e) {
cli::cli_abort('layout function must return an object coerceble to either a {.cls data.frame} or {.cls tbl_graph}')
}
)
}
)
}
if (is.tbl_graph(layout)) {
graph <- layout
nodes <- as_tibble(graph, active = 'nodes')
attr(nodes, 'graph') <- graph
} else {
nodes <- combine_layout_nodes(layout, as_tibble(graph, active = 'nodes'))
}
nodes
}
igraphlayouts <- c(
'as_bipartite',
'as_star',
'as_tree',
'in_circle',
'nicely',
'with_dh',
'with_drl',
'with_gem',
'with_graphopt',
'on_grid',
'with_mds',
'with_sugiyama',
'on_sphere',
'randomly',
'with_fr',
'with_kk',
'with_lgl'
)
|