2

重複の可能性:
Roxygen: ジェネリックの S3 メソッドを別のパッケージに適切に文書化する方法は?

パッケージ coda で定義されている as.mcmc に基づいてメソッド as.mcmc.mcmcComposite を作成しようとしています。コードは次のとおりです。

#' as.mcmc Extract mcmc object from a result to be used with coda package
#' @title Extract mcmc object from a result to be used with coda package
#' @author Marc Girondot
#' @return A mcmc.list object
#' @param x A result object
#' @description Take a mcmcComposite object and create a mcmc.list object
#' @examples
#' # Try
#’ method as.mcmc mcmcComposite
#' @export


as.mcmc.mcmcComposite <-
function(x) {
    return(x$resultMCMC)
}

うまく機能しますが、チェック中にエラーが発生します。

* checking Rd \usage sections ... NOTE
S3 methods shown with full name in documentation object 'as.mcmc.mcmcComposite':
  ‘as.mcmc.mcmcComposite’

The \usage entries for S3 methods should use the \method markup and not
their full name.
See the chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.

このようなエラーを修正する方法がわかりません。アドバイスをありがとう

マルク・ジロンド

4

0 に答える 0