Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

R-CMD Check Warning - Missing link or links in documentation object #1601

Open
jan-abel-inwt opened this issue Mar 21, 2024 · 0 comments
Open

Comments

@jan-abel-inwt
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant