R Roxygen链接到父功能

时间:2013-11-16 03:19:17

标签: r inheritance roxygen

考虑一个由其他人编写的基础包XYZ,它有一个函数ABC,我想在我的新(NOT XYZ)包中扩展ABC的功能。以下方法。

ABC <- function(...){
  ##INSERT EXTRA WORK.

  ##CALL THE BASE METHOD
  XYZ::ABC(...)
}

现在我想记录我的新函数ABC(通过Roxygen),创建一个指向父函数的链接以供参考。

\code{\link{XYZ::ABC}}不起作用,找不到任何功能。

\link{ABC}创建指向可能的Candiate Rd文件列表的链接

如何为 BASE 功能创建 DIRECTLY 超链接。

1 个答案:

答案 0 :(得分:7)

\code{\link[XYZ]{ABC}}

在写作R扩展的Cross-references部分中简要记录了这一点:

  

另外两种形式的可选参数指定为\ link [pkg] {foo}和\ link [pkg:bar] {foo}分别链接到包pkg,文件foo.html和bar.html。