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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
|
#' Draw edges as Arcs
#'
#' This geom is mainly intended for arc linear and circular diagrams (i.e. used
#' together with [layout_tbl_graph_linear()]), though it can be used
#' elsewhere. It draws edges as arcs with a height proportional to the distance
#' between the nodes. Arcs are calculated as beziers. For linear layout the
#' placement of control points are related to the `curvature` argument and
#' the distance between the two nodes. For circular layout the control points
#' are placed on the same angle as the start and end node at a distance related
#' to the distance between the nodes.
#'
#' @inheritSection geom_edge_link Edge variants
#' @inheritSection geom_edge_link Edge aesthetic name expansion
#'
#' @section Aesthetics:
#' `geom_edge_arc` and `geom_edge_arc0` understand the following
#' aesthetics. Bold aesthetics are automatically set, but can be overwritten.
#'
#' - **x**
#' - **y**
#' - **xend**
#' - **yend**
#' - **circular**
#' - edge_colour
#' - edge_width
#' - edge_linetype
#' - edge_alpha
#' - filter
#'
#' `geom_edge_arc2` understand the following aesthetics. Bold aesthetics are
#' automatically set, but can be overwritten.
#'
#' - **x**
#' - **y**
#' - **group**
#' - **circular**
#' - edge_colour
#' - edge_width
#' - edge_linetype
#' - edge_alpha
#' - filter
#'
#' `geom_edge_arc` and `geom_edge_arc2` furthermore takes the following
#' aesthetics.
#'
#' - start_cap
#' - end_cap
#' - label
#' - label_pos
#' - label_size
#' - angle
#' - hjust
#' - vjust
#' - family
#' - fontface
#' - lineheight
#'
#'
#' @section Computed variables:
#'
#' \describe{
#' \item{index}{The position along the path (not computed for the *0 version)}
#' }
#'
#' @inheritParams geom_edge_link
#' @inheritParams ggplot2::geom_path
#'
#' @param strength The bend of the curve. 1 approximates a halfcircle while 0
#' will give a straight line. Negative number will change the direction of the
#' curve. Only used if `circular = FALSE`.
#'
#' @param fold Logical. Should arcs appear on the same side of the nodes despite
#' different directions. Default to `FALSE`.
#'
#' @param curvature Deprecated. Use `strength` instead.
#'
#' @author Thomas Lin Pedersen
#'
#' @family geom_edge_*
#'
#' @examples
#' require(tidygraph)
#' # Make a graph with different directions of edges
#' gr <- create_notable('Meredith') %>%
#' convert(to_directed) %>%
#' mutate(class = sample(letters[1:3], n(), replace = TRUE)) %>%
#' activate(edges) %>%
#' mutate(
#' class = sample(letters[1:3], n(), replace = TRUE),
#' switch = sample(c(TRUE, FALSE), n(), replace = TRUE)
#' ) %>%
#' reroute(from = to, to = from, subset = switch)
#'
#' ggraph(gr, 'linear') +
#' geom_edge_arc(aes(alpha = after_stat(index)))
#'
#' ggraph(gr, 'linear') +
#' geom_edge_arc2(aes(colour = node.class), strength = 0.6)
#'
#' ggraph(gr, 'linear', circular = TRUE) +
#' geom_edge_arc0(aes(colour = class))
#' @rdname geom_edge_arc
#' @name geom_edge_arc
#'
NULL
#' @rdname ggraph-extensions
#' @format NULL
#' @usage NULL
#' @importFrom ggforce StatBezier
#' @export
StatEdgeArc <- ggproto('StatEdgeArc', StatBezier,
setup_data = function(data, params) {
data <- StatFilter$setup_data(data, params)
data <- remove_loop(data)
if (nrow(data) == 0) return(data)
data$group <- make_unique(data$group)
data2 <- data
data2$x <- data2$xend
data2$y <- data2$yend
create_arc(data, data2, params)
},
required_aes = c('x', 'y', 'xend', 'yend', 'circular'),
default_aes = aes(filter = TRUE),
extra_params = c('na.rm', 'n', 'strength', 'fold', 'curvature')
)
#' @rdname geom_edge_arc
#'
#' @export
geom_edge_arc <- function(mapping = NULL, data = get_edges(),
position = 'identity', arrow = NULL, strength = 1,
n = 100, fold = FALSE, lineend = 'butt',
linejoin = 'round', linemitre = 1,
label_colour = 'black', label_alpha = 1,
label_parse = FALSE, check_overlap = FALSE,
angle_calc = 'rot', force_flip = TRUE,
label_dodge = NULL, label_push = NULL,
show.legend = NA, ..., curvature) {
if (!missing(curvature)) {
lifecycle::deprecate_warn('2.0.0', 'geom_edge_arc(curvature)', 'geom_edge_arc(strength)')
strength <- curvature
}
mapping <- complete_edge_aes(mapping)
mapping <- aes_intersect(mapping, aes(
x = x, y = y, xend = xend, yend = yend,
circular = circular, group = edge.id
))
layer(
data = data, mapping = mapping, stat = StatEdgeArc,
geom = GeomEdgePath, position = position, show.legend = show.legend,
inherit.aes = FALSE,
params = expand_edge_aes(
list2(
arrow = arrow, lineend = lineend, linejoin = linejoin,
linemitre = linemitre, n = n,
interpolate = FALSE, strength = strength, fold = fold,
label_colour = label_colour, label_alpha = label_alpha,
label_parse = label_parse, check_overlap = check_overlap,
angle_calc = angle_calc, force_flip = force_flip,
label_dodge = label_dodge, label_push = label_push, ...
)
)
)
}
#' @rdname ggraph-extensions
#' @format NULL
#' @usage NULL
#' @importFrom ggforce StatBezier2
#' @export
StatEdgeArc2 <- ggproto('StatEdgeArc2', StatBezier2,
setup_data = function(data, params) {
data <- StatFilter$setup_data(data, params)
data <- remove_loop2(data)
if (nrow(data) == 0) return(data)
data <- data[order(data$group), ]
data2 <- data[c(FALSE, TRUE), ]
data <- data[c(TRUE, FALSE), ]
create_arc(data, data2, params)
},
required_aes = c('x', 'y', 'group', 'circular'),
default_aes = aes(filter = TRUE),
extra_params = c('na.rm', 'n', 'strength', 'fold', 'curvature')
)
#' @rdname geom_edge_arc
#'
#' @export
geom_edge_arc2 <- function(mapping = NULL, data = get_edges('long'),
position = 'identity', arrow = NULL, strength = 1,
n = 100, fold = FALSE, lineend = 'butt',
linejoin = 'round', linemitre = 1,
label_colour = 'black', label_alpha = 1,
label_parse = FALSE, check_overlap = FALSE,
angle_calc = 'rot', force_flip = TRUE,
label_dodge = NULL, label_push = NULL,
show.legend = NA, ..., curvature) {
if (!missing(curvature)) {
lifecycle::deprecate_warn('2.0.0', 'geom_edge_arc2(curvature)', 'geom_edge_arc2(strength)')
strength <- curvature
}
mapping <- complete_edge_aes(mapping)
mapping <- aes_intersect(mapping, aes(
x = x, y = y, group = edge.id,
circular = circular
))
layer(
data = data, mapping = mapping, stat = StatEdgeArc2,
geom = GeomEdgePath, position = position, show.legend = show.legend,
inherit.aes = FALSE,
params = expand_edge_aes(
list2(
arrow = arrow, lineend = lineend, linejoin = linejoin,
linemitre = linemitre, n = n,
interpolate = TRUE, strength = strength, fold = fold,
label_colour = label_colour, label_alpha = label_alpha,
label_parse = label_parse, check_overlap = check_overlap,
angle_calc = angle_calc, force_flip = force_flip,
label_dodge = label_dodge, label_push = label_push, ...
)
)
)
}
#' @rdname ggraph-extensions
#' @format NULL
#' @usage NULL
#' @importFrom ggforce StatBezier0
#' @export
StatEdgeArc0 <- ggproto('StatEdgeArc0', StatBezier0,
setup_data = function(data, params) {
StatEdgeArc$setup_data(data, params)
},
required_aes = c('x', 'y', 'xend', 'yend', 'circular'),
default_aes = aes(filter = TRUE),
extra_params = c('na.rm', 'strength', 'fold', 'curvature')
)
#' @rdname geom_edge_arc
#'
#' @export
geom_edge_arc0 <- function(mapping = NULL, data = get_edges(),
position = 'identity', arrow = NULL, strength = 1,
lineend = 'butt', show.legend = NA, fold = fold, ..., curvature) {
if (!missing(curvature)) {
lifecycle::deprecate_warn('2.0.0', 'geom_edge_arc0(curvature)', 'geom_edge_arc0(strength)')
strength <- curvature
}
mapping <- complete_edge_aes(mapping)
mapping <- aes_intersect(mapping, aes(
x = x, y = y, xend = xend, yend = yend,
circular = circular
))
layer(
data = data, mapping = mapping, stat = StatEdgeArc0,
geom = GeomEdgeBezier, position = position, show.legend = show.legend,
inherit.aes = FALSE,
params = expand_edge_aes(
list2(
arrow = arrow, lineend = lineend, strength = strength, fold = FALSE, ...
)
)
)
}
create_arc <- function(from, to, params) {
bezier_start <- seq(1, by = 4, length.out = nrow(from))
from$index <- bezier_start
to$index <- bezier_start + 3
data2 <- from
data3 <- to
data2$index <- bezier_start + 1
data3$index <- bezier_start + 2
node_dist <- sqrt((to$x - from$x)^2 + (to$y - from$y)^2) / 2
circ <- from$circular
if (any(circ)) {
r0 <- sqrt(to$x[circ]^2 + to$y[circ]^2)
r1 <- sqrt(to$x[circ]^2 + to$y[circ]^2)
data2$x[circ] <- from$x[circ] * (1 - (node_dist[circ] / r0))
data2$y[circ] <- from$y[circ] * (1 - (node_dist[circ] / r0))
data3$x[circ] <- to$x[circ] * (1 - (node_dist[circ] / r1))
data3$y[circ] <- to$y[circ] * (1 - (node_dist[circ] / r1))
}
if (any(!circ)) {
strength <- pi / 2 * -params$strength
edge_angle <- atan2(
to$y[!circ] - from$y[!circ],
to$x[!circ] - from$x[!circ]
)
start_angle <- edge_angle - strength
end_angle <- edge_angle - pi + strength
data2$x[!circ] <- data2$x[!circ] + cos(start_angle) * node_dist[!circ]
data2$y[!circ] <- data2$y[!circ] + sin(start_angle) * node_dist[!circ]
data3$x[!circ] <- data3$x[!circ] + cos(end_angle) * node_dist[!circ]
data3$y[!circ] <- data3$y[!circ] + sin(end_angle) * node_dist[!circ]
if (params$fold) {
# data2$x[!circ] <- abs(data2$x[!circ]) * sign(params$strength)
data2$y[!circ] <- abs(data2$y[!circ]) * sign(params$strength)
# data3$x[!circ] <- abs(data3$x[!circ]) * sign(params$strength)
data3$y[!circ] <- abs(data3$y[!circ]) * sign(params$strength)
}
}
data <- vec_rbind(from, data2, data3, to)
data[order(data$index), names(data) != 'index']
}
|