Roxygen2文档S4通用来自依赖包

时间:2015-01-20 16:15:04

标签: r s4 roxygen2

一般问题 - 我如何使用roxygen来记录我扩展的依赖包中的泛型,特别是usage语句。

假设我正在扩展包coolPackage。在其中,有一个名为coolFun的泛型,它有自己的一组方法。

现在,我为不同的目的创建了一个辅助包,并使用更多方法扩展了S4 coolFun。现在,通常我可以使用@rdname并将多个函数添加到同一个文件中。

#' @rdname coolFun
#' @export
setMethod('coolFun', signature(x='newClass'),
    function(x){
       #process the class
    }
)

然而,这导致如下所示:

Usage

## S4 method for signature 'newClass'
coolFun(x)

如果我只使用一种或两种方法,那就没问题,但是假设我有几种方法。 S4评论将重复多次,呼叫本身永远不会有所不同。我理解表示S4方法的重要性,但有没有办法解决这种类型的行为,所以我可以只有一个文件有多个别名(对于所有新方法),它返回简单的输出,而不是杂乱,重复的文档?< / p>

Usage

coolFun(x)

如果泛型在第二个包中,这将很容易,但我不知道如何在手动写出Rd文件之后访问它(这是使用roxygen的全部原因)。这可能是不可能的,但它会使文档看起来更清洁,恕我直言。

0 个答案:

没有答案