Документирование классов / методов R.oo с помощью Roxygen - PullRequest
Новая
       75

Документирование классов / методов R.oo с помощью Roxygen

5 голосов
/ 26 августа 2011

Может ли кто-нибудь указать мне хороший пример документирования классов / методов R.oo с помощью Roxygen?В R.oo классы / методы создаются вызовами setConstructorS3 () и setMethodS3 (), поэтому нет функции для документирования как таковой.Вы просто создаете стандартную документацию по функциям Roxygen, но помещаете ее поверх оператора NULL?

Ответы [ 2 ]

3 голосов
/ 29 августа 2011

Я думаю,

  1. @usage.
  2. Аргумент точка-точка-точка необходим в функции MyMethod.ClassName для универсальности S3 / согласованности методов.
  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
})
2 голосов
/ 26 августа 2011

После некоторых проб и ошибок вот что я придумал. Это решение гарантирует, что все объекты экспортируются должным образом, что сборка / проверка 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 ) { ... } )
...