r - R CMD检查警告:在文档对象中使用但未在代码中使用的功能/方法

标签 r package roxygen2

我正在编写一个程序包,但是一个持续的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.}

相关问题(但我已经实现了建议,仍然没有运气):
  • How to properly document a S3 method of a generic from a different package, using Roxygen?


  • 我要去哪里了?如何从包装检查中删除此警告?

    最佳答案

    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/

    相关文章:

    R 没有连接到 HDFS

    javascript - 如何使用已安装的包更新 bower.json?

    variables - Go中函数体外部的非声明语句

    r - 使用 Roxygen 和 testthat,使内部辅助函数可用于 R CMD 检查期间调用的测试用例的正确方法是什么?

    r - 将依赖项正确添加到 r 包中,以便它们自动安装

    r - 使用 dplyr::case_when 进行整洁的评估编程

    r - 对使用 [ ] 索引颜色列表感到困惑

    python - 如何在jupyter笔记本中安装pygame包?

    r - roxygen2 6.0.0 现在在最后一行需要 "@export"吗?

    r - 使用从 R 上的另一列中提取的信息创建新列