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.}

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

How to properly document a S3 method of a generic from a different package, using Roxygen?

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

Answer 1

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

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

如果@method行没有自动插入（我认为只会添加\method{names}{surveydata}(x)？），那么您需要一个包含上述内容的明确@usage部分。像

这样的东西

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

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

基本上，警告来自于您的包不包含函数"names<-"但您在\usage{}中使用此函数的事实。

Answer 2

如果对任何人都有用，则此错误也可能是由于废弃的Rd文件而导致的，该文件不再具有功能或数据对象。

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

2 个答案: