You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I want to get rid of the following warning in the r-cmd check:
* checking Rd cross-references ... WARNING
Missing link or links in documentation object 'fullJoinByExistingKey.Rd':
‘[dplyr:join_by]{join_by()}’ ‘[dplyr:join_by]{?join_by}’
‘[dplyr:cross_join]{cross_join()}’
My roxygen comment of this function looks like that:
#' Full Join By Existing Key
#'
#' Filter for existing keys in y. Join y only on existing keys.
#'
#' @param nameOfY name of y, used only in warnings
#' @inheritParams dplyr::full_join
fullJoinByExistingKey <- function(x, y, by = NULL, nameOfY = "") {
The relevant line from the Rd File generated by roxygen2 :
\item{by}{A join specification created with \code{\link[dplyr:join_by]{join_by()}}, or a character
vector of variables to join by.
...
To join on different variables between \code{x} and \code{y}, use a \code{\link[dplyr:join_by]{join_by()}}
specification. For example, \code{join_by(a == b)} will match \code{x$a} to \code{y$b}.
...
To join by multiple variables, use a \code{\link[dplyr:join_by]{join_by()}} specification with
multiple expressions. For example, \code{join_by(a == b, c == d)} will match
\code{x$a} to \code{y$b} and \code{x$c} to \code{y$d}. If the column names are the same between
\code{x} and \code{y}, you can shorten this by listing only the variable names, like
\code{join_by(a, c)}.
\code{\link[dplyr:join_by]{join_by()}} can also be used to perform inequality, rolling, and overlap
joins. See the documentation at \link[dplyr:join_by]{?join_by} for details on
these types of joins.
...
To perform a cross-join, generating all combinations of \code{x} and \code{y}, see
\code{\link[dplyr:cross_join]{cross_join()}}.}
What did I do wrong or is this a bug?
The text was updated successfully, but these errors were encountered:
I want to get rid of the following warning in the r-cmd check:
My roxygen comment of this function looks like that:
The relevant line from the Rd File generated by roxygen2 :
What did I do wrong or is this a bug?
The text was updated successfully, but these errors were encountered: