pack_join() returns all rows and columns in
x with a new packed column
that contains all matches from
pack_join(x, y, by = NULL, ..., copy = FALSE, keep = FALSE, name = NULL) # S3 method for dm_zoomed pack_join(x, y, by = NULL, ..., copy = FALSE, keep = FALSE, name = NULL)
- x, y
A pair of data frames or data frame extensions (e.g. a tibble).
A join specification created with
join_by(), or a character vector of variables to join by.
NULL, the default,
*_join()will perform a natural join, using all variables in common across
y. A message lists the variables so that you can check they're correct; suppress the message by supplying
To join on different variables between
y, use a
join_by()specification. For example,
join_by(a == b)will match
To join by multiple variables, use a
join_by()specification with multiple expressions. For example,
join_by(a == b, c == d)will match
y$d. If the column names are the same between
y, you can shorten this by listing only the variable names, like
join_by()can also be used to perform inequality, rolling, and overlap joins. See the documentation at ?join_by for details on these types of joins.
For simple equality joins, you can alternatively specify a character vector of variable names to join by. For example,
by = c("a", "b")joins
y$b. If variable names differ between
y, use a named character vector like
by = c("x_a" = "y_a", "x_b" = "y_b").
To perform a cross-join, generating all combinations of
Other parameters passed onto methods.
yare not from the same data source, and
ywill be copied into the same src as
x. This allows you to join tables across srcs, but it is a potentially expensive operation so you must opt into it.
Should the new list-column contain join keys? The default will preserve the join keys for inequality joins.
The name of the list-column created by the join. If
NULL, the default, the name of