【问题标题】:R Roxygen link to parent functionR Roxygen 链接到父函数
【发布时间】:2013-11-16 03:19:17
【问题描述】:

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

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

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

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

\code{\link{XYZ::ABC}}不起作用,找不到函数。

\link{ABC} 创建一个指向可能候选 Rd 文件列表的链接,

如何创建直接BASE函数的超链接。

【问题讨论】:

  • @importsFrom XYZ ABC,不是吗?
  • \code{\link[XYZ]{ABC}}
  • 就是这样。把它放在一个答案中,我会勾选它。

标签: r inheritance roxygen


【解决方案1】:

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

这在编写 R 扩展的 Cross-references 部分中有简要记录:

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

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2016-11-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2023-02-10
    • 2016-10-23
    • 1970-01-01
    相关资源
    最近更新 更多