r - Roxygenを使用したR.ooクラス/メソッドの文書化

Question

誰かがRoxygenでR.ooクラス/メソッドを文書化する良い例を教えてもらえますか？R.ooでは、クラス/メソッドはsetConstructorS3（）およびsetMethodS3（）の呼び出しによって作成されるため、それ自体を文書化する関数はありません。標準のRoxygen関数のドキュメントを作成するだけで、NULLステートメントの上に配置しますか？

Answer 1

おもう、

1. @usage必要です。
2. MyMethod.ClassNameS3ジェネリック/メソッドの一貫性を保つために、関数にはdot-dot-dot引数が必要です。
3. ではなく#' @export MyMethod.ClassNameむしろ#' @S3method MyMethod ClassName？

サンプルコード：

#' Title.  More Info.
#'
#' @usage MyMethod(...)
#' @param this this.
#' @param someParam Param info.
#' @param ... other arguments.
#'
#' @rdname   MyMethod
#' @export   MyMethod
#' @name     MyMethod
NULL

#' @usage \method{MyMethod}{ClassName}(this, someParam, ...)
#' @return MyMethod.ClassName:
#' \code{NULL}
#'
#' @rdname   MyMethod
#' @S3method MyMethod ClassName
#' @name     MyMethod.ClassName
setMethodS3("MyMethod", "ClassName", appendVarArgs = FALSE, 
function(this, someParam, ...) {
  NULL
})

Answer 2

いくつかの試行錯誤の末、これが私が思いついたものです。このソリューションにより、すべてのオブジェクトが適切にエクスポートされ、R CMDビルド/チェックが実行されないこと、冗長なドキュメントがないこと、および例が実行されることが保証されます。@exportが@method/ @ S3methodに置き換えられた場合、ソリューションは機能しないことに注意してください。理論的にはそれでうまくいくはずですが、私にとってはうまくいきませんでした。誰かがより良い解決策を持っていますか？

#' Title.  More Info.
#'
#' @param someParam  Param info.
#'
#' @name     MyMethod
#' @export   MyMethod
NULL
#' @rdname   MyMethod
#' @name     MyMethod.ClassName
#' @export   MyMethod.ClassName
setMethodS3( "MyMethod" , "ClassName" , appendVarArgs = FALSE , 
function( this , someParam ) { ... } )