如何在R中正确记录roxygen2的方法

时间:2018-03-22 20:17:33

标签: r s4 roxygen2

我有一个名为" FOO"的自定义类,并希望设置"长度"该类的方法。这是一个模板:

#' Returns the length of the FOO object
#'
#' @name length
#' @param x a FOO object
#' @aliases XXX
#' @rdname YYY
#' @docType methods
setMethod("length", "tmod",
  function(x) {
    nrow(x$BLAH)
  })

方法本身可以正常工作。

bar <- list(BLAH=1:10)
bar <- as(bar, "FOO")
length(bar)

...返回10.

我的问题:应该输入什么而不是&#34; XXX&#34;和&#34; YYY&#34;?在&#34;写R扩展&#34;中记录S4方法和类的条目。说得有点偏空,说得客气一点。 roxygen2的文档正在使用组成的示例。但是如果我想使用一个我没有定义的泛型,我该怎么办?

请注意,this question之间的区别在于我特别要求定义&#34;长度&#34;对应于基础包中的功能的方法。这与&#34; show&#34;完全不同。其中一个&#34; show-methods&#34;手册页已经存在。

0 个答案:

没有答案