我正在编写一个程序包,但是一个持续的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.
}
我已经将我的文档与base 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.}
相关问题(但我已经实现了建议,仍然没有运气):
我要去哪里了?如何从包装检查中删除此警告?
最佳答案
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{}
中使用此函数。
关于r - R CMD检查警告:在文档对象中使用但未在代码中使用的功能/方法,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11285496/