[R CMD检查警告:函数/方法与文档对象使用......但不是在代码(R CMD check wa

2019-07-30 04:46发布

我写一个方案,但一个持久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.
}

我已经交叉检查我的文档与文件names<-在基础R,似乎相同:

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

相关的问题(但我已经执行的建议,仍然没有运气):

  • 如何正确地从不同的包文件的通用的S3方法,使用Roxygen?

我要去哪里错了? 我怎样才能从包中取出检查这个警告?

Answer 1:

\usage在路文件部分需要包括以下内容:

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

如果没有自动插入@method线(我相信这只会增加\method{names}{surveydata}(x) ?),那么你需要一个明确的@usage部分包括上述内容。 就像是

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

我也改变@name@alias段提及的方法明确不作为将与R中::基地路文件冲突的一般。

从本质上讲,警告的事实,你的包包含一个函数来了"names<-"但是你在使用这个\usage{}



Answer 2:

如果它可以帮助任何人,也可以从一个功能或数据对象不再存在一个废弃的路文件出现此错误。



文章来源: R CMD check warning: Functions/methods with usage in documentation object … but not in code