graph_join
Join graphs on common nodes
This graph-specific join method makes a full join on the nodes data and
updates the edges in the joining graph so they matches the new indexes of the
nodes in the resulting graph. Node and edge data is combined using
dplyr::bind_rows()
semantic, meaning that data is matched by column name
and filled with NA
if it is missing in either of the graphs.
Usage
graph_join(x, y, by = NULL, copy = FALSE, suffix = c(".x", ".y"),
...)
Arguments
- x
A
tbl_graph
- y
An object convertible to a
tbl_graph
usingas_tbl_graph()
- by
a character vector of variables to join by. If
NULL
, the default,*_join()
will do a natural join, using all variables with common names across the two tables. A message lists the variables so that you can check they're right (to suppress the message, simply explicitly list the variables that you want to join).To join by different variables on x and y use a named vector. For example,
by = c("a" = "b")
will matchx.a
toy.b
.- copy
If
x
andy
are not from the same data source, andcopy
isTRUE
, theny
will be copied into the same src asx
. This allows you to join tables across srcs, but it is a potentially expensive operation so you must opt into it.- suffix
If there are non-joined duplicate variables in
x
andy
, these suffixes will be added to the output to disambiguate them. Should be a character vector of length 2.- ...
other parameters passed onto methods, for instance,
na_matches
to control howNA
values are matched. See join.tbl_df for more.
Value
A tbl_graph
containing the merged graph
Examples
# NOT RUN {
gr1 <- create_notable('bull') %>%
activate(nodes) %>%
mutate(name = letters[1:5])
gr2 <- create_ring(10) %>%
activate(nodes) %>%
mutate(name = letters[4:13])
gr1 %>% graph_join(gr2)
# }