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
|
#' Draw edges as diagonals
#'
#' This geom draws edges as diagonal bezier curves. The name comes from D3.js
#' where this shape was called diagonals until it was renamed to
#' [links](https://github.com/d3/d3-shape/blob/v1.3.5/README.md#links).
#' A diagonal in this context is a quadratic bezier with the control points
#' positioned halfway between the start and end points but on the same axis.
#' This produces a pleasing fan-in, fan-out line that is mostly relevant for
#' hierarchical layouts as it implies an overall directionality in the plot.
#'
#' @inheritSection geom_edge_link Edge variants
#' @inheritSection geom_edge_link Edge aesthetic name expansion
#'
#' @section Aesthetics:
#' `geom_edge_diagonal` and `geom_edge_diagonal0` 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_diagonal2` 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_diagonal` and `geom_edge_diagonal2` 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 flipped Logical, Has the layout been flipped by reassigning the
#' mapping of x, y etc?
#'
#' @param strength The strength of the curvature of the diagonal. `0` will
#' result in a straight line while `1` will give the familiar S-shape.
#'
#' @author Thomas Lin Pedersen
#'
#' @family geom_edge_*
#'
#' @examples
#' require(tidygraph)
#' gr <- create_tree(20, 4) %>%
#' mutate(class = sample(letters[1:3], n(), replace = TRUE)) %>%
#' activate(edges) %>%
#' mutate(class = sample(letters[1:3], n(), replace = TRUE))
#'
#' ggraph(gr, 'tree') +
#' geom_edge_diagonal(aes(alpha = after_stat(index)))
#'
#' ggraph(gr, 'tree') +
#' geom_edge_diagonal2(aes(colour = node.class))
#'
#' ggraph(gr, 'tree') +
#' geom_edge_diagonal0(aes(colour = class))
#' @rdname geom_edge_diagonal
#' @name geom_edge_diagonal
#'
NULL
#' @rdname ggraph-extensions
#' @format NULL
#' @usage NULL
#' @importFrom ggforce StatBezier
#' @export
StatEdgeDiagonal <- ggproto('StatEdgeDiagonal', 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_diagonal(data, data2, params)
},
required_aes = c('x', 'y', 'xend', 'yend', 'circular'),
default_aes = aes(filter = TRUE),
extra_params = c('na.rm', 'flipped', 'n', 'strength')
)
#' @rdname geom_edge_diagonal
#'
#' @export
geom_edge_diagonal <- function(mapping = NULL, data = get_edges(),
position = 'identity', arrow = NULL, strength = 1,
flipped = FALSE, n = 100, 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, ...) {
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 = StatEdgeDiagonal,
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, flipped = flipped, strength = strength,
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
StatEdgeDiagonal2 <- ggproto('StatEdgeDiagonal2', 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_diagonal(data, data2, params)
},
required_aes = c('x', 'y', 'group', 'circular'),
default_aes = aes(filter = TRUE),
extra_params = c('na.rm', 'flipped', 'n', 'strength')
)
#' @rdname geom_edge_diagonal
#'
#' @export
geom_edge_diagonal2 <- function(mapping = NULL, data = get_edges('long'),
position = 'identity', arrow = NULL, strength = 1,
flipped = FALSE, n = 100, 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, ...) {
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 = StatEdgeDiagonal2,
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, flipped = flipped, strength = strength,
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
StatEdgeDiagonal0 <- ggproto('StatEdgeDiagonal0', StatBezier0,
setup_data = function(data, params) {
StatEdgeDiagonal$setup_data(data, params)
},
required_aes = c('x', 'y', 'xend', 'yend', 'circular'),
default_aes = aes(filter = TRUE),
extra_params = c('na.rm', 'flipped', 'strength')
)
#' @rdname geom_edge_diagonal
#'
#' @export
geom_edge_diagonal0 <- function(mapping = NULL, data = get_edges(),
position = 'identity', arrow = NULL, strength = 1,
flipped = FALSE, lineend = 'butt',
show.legend = NA, ...) {
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 = StatEdgeDiagonal0,
geom = GeomEdgeBezier, position = position, show.legend = show.legend,
inherit.aes = FALSE,
params = expand_edge_aes(
list2(
arrow = arrow, lineend = lineend, strength = strength,
flipped = flipped, ...
)
)
)
}
create_diagonal <- 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
if (any(from$circular)) {
r0 <- sqrt(from$x[from$circular]^2 + from$y[from$circular]^2)
r1 <- sqrt(to$x[to$circular]^2 + to$y[to$circular]^2)
root <- r0 == 0 | r1 == 0
r_mod <- params$strength * (r1 - r0) / 2
data2$x[from$circular] <- from$x[from$circular] / (r0 / (r0 + r_mod))
data2$y[from$circular] <- from$y[from$circular] / (r0 / (r0 + r_mod))
data3$x[from$circular] <- to$x[from$circular] / (r1 / (r1 - r_mod))
data3$y[from$circular] <- to$y[from$circular] / (r1 / (r1 - r_mod))
data2$x[root] <- from$x[root]
data2$y[root] <- from$y[root]
data3$x[root] <- to$x[root]
data3$y[root] <- to$y[root]
}
if (any(!from$circular)) {
if (params$flipped) {
h_diff <- from$x[!from$circular] - to$x[!from$circular]
data2$x[!from$circular] <- from$x[!from$circular] - h_diff / 2 * params$strength
data3$x[!from$circular] <- to$x[!from$circular] + h_diff / 2 * params$strength
} else {
h_diff <- from$y[!from$circular] - to$y[!from$circular]
data2$y[!from$circular] <- from$y[!from$circular] - h_diff / 2 * params$strength
data3$y[!from$circular] <- to$y[!from$circular] + h_diff / 2 * params$strength
}
}
data <- vec_rbind(from, data2, data3, to)
data[order(data$index), names(data) != 'index']
}
|
