21

パッケージを作成していますが、1 つの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.}

関連する質問（しかし、私はすでに提案を実装していますが、まだ運がありません）：

どこが間違っていますか？この警告をパッケージ チェックから削除するにはどうすればよいですか?

4

2 に答える 2

15

Rd ファイルの\usageセクションには、以下を含める必要があります。

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

これが@method行によって自動的に挿入されない場合 (追加されるのは ? だけだと思います) 、上記を含む明示的なセクション\method{names}{surveydata}(x)が必要です。@usage何かのようなもの

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

また、R::base の Rd ファイルと競合するため、ジェネリックではなくメソッドを明示的に参照するようにセクション@nameとセクションを変更します。@alias

基本的に、警告は、パッケージに関数が含まれていないにもかかわらず"names<-"、これを で使用しているという事実から来ています\usage{}。

于 2012-07-01T21:45:22.853 に答える