r - R CMD检查警告：在文档对象中使用的函数/方法......但不在代码中

Question

我正在写一个包，但一个持续的R CMD check警告阻止我完成包并将其发布到 CRAN。我roxygen2用于内联文档，尽管这可能不是错误的根本原因。

如果您知道如何删除此警告，我很可能会想出一种使用roxygen2.

如何 Functions/methods with usage in documentation object ... but not in code 从包裹检查中删除警告？

---

R CMD check警告：

* checking for code/documentation mismatches ... WARNING
Functions/methods with usage in documentation object 'names<-' but not in code:
  names<-

功能和roxygen文档：

#' Updates names and variable.labels attribute of surveydata.
#' 
#' @name names<-
#' @rdname names
#' @aliases names<- names<-.surveydata
#' @param x surveydata object
#' @param value New names
#' @method names<- surveydata
#' @usage names(x) <- value
"names<-.surveydata" <- function(x, value){
    invisible(NULL)
}

生成的.rd文档文件：

\name{names<-}
\alias{names<-}
\alias{names<-.surveydata}
\title{Updates names and variable.labels attribute of surveydata.}
\usage{
  names(x) <- value
}
\arguments{
  \item{x}{surveydata object}

  \item{value}{New names}
}
\description{
  Updates names and variable.labels attribute of
  surveydata.
}

---

我已经将我的文档与基础 R 中的文档进行了交叉检查names<-，看起来是相同的：

\title{  The Names of an Object}
\name{names}
\alias{names}
\alias{names.default}
\alias{names<-}
\alias{names<-.default}
\keyword{attribute}
\description{Functions to get or set the names of an object.}

---

相关问题（但我已经实施了这个建议，但仍然没有运气）：

• 如何使用 Roxygen 正确记录来自不同包的泛型的 S3 方法？

---

我哪里错了？如何从包裹检查中删除此警告？

Answer 1

Rd 文件中的\usage部分需要包括以下内容：

\method{names}{surveydata}(x) <- value

如果这不是由该@method行自动插入（我认为只会添加\method{names}{surveydata}(x)？），那么您需要一个@usage包含上述内容的显式部分。就像是

#' @usage \\method{names}{surveydata}(x) <- value

我还将更改@nameand@alias部分以明确引用该方法而不是泛型，因为这将与 R::base 中的 Rd 文件发生冲突。

本质上，警告来自您的包不包含函数"names<-"但您在\usage{}.

Answer 2

万一它对任何人都有帮助，这个错误也可能来自一个废弃的 Rd 文件，它的函数或数据对象不再存在。