链接到R中roxygen2文档中的其他包

Question

我想知道link当我尝试使用新包编写文档时,存在一种从其他包中运行的方法roxygen2.有点像\link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}？

Answer 1

你必须输入 \link[pkg]{function}例如\link[stringi]{stri_c}

Answer 2

Roxygen2 现在还支持用 Markdown 编写的文档。

Markdown语法用于链接 is [foo::bar()]，它\code{\link[foo:bar]{foo::bar()}}在生成的 .Rd 文件中被转换 。（请参阅Roxygen2 小插图。）

请注意，如果您只想为特定手册页启用Markdown，您可能需要通过Roxygen: list(markdown = TRUE)在DESCRIPTION文件中写入或添加#' @md注释来专门打开 Markdown 支持。这也在链接小插图的最顶部进行了解释。（感谢@Tjebo 的评论）

请注意，markdown 版本中有两个冒号，而 Rd 版本中只有一个冒号。

Answer 3

除了potockan的答案之外：
有些软件包在单个帮助页面中记录了一些功能。例如，trimBioconductor软件包GenomicRanges的功能记录在intra-range-methods其中（这也是其他软件包（例如IRanges）的帮助页面的名称）。

要链接到正确的页面，roxygen2您可以使用：

\link[GenomicRanges:intra-range-methods]{trim} 

要么

\code{\link[GenomicRanges:intra-range-methods]{trim}}  

正确格式化文本。

帮助页面只会显示，trim但会链接到正确的帮助页面。

Answer 4

从书R 包：

• \code{\link{function}} - 此包中的功能。
• \code{\link[MASS]{abbey}} - 在另一个包中的功能。
• \link[=dest]{name} - 链接到目标，但显示名称。
• \code{\link[MASS:abbey]{name}} - 链接到另一个包中的函数，但显示名称。
• \linkS4class{abc} - 链接到 S4 课程。

注意：在第四个选项中只有一个冒号，而不是在代码中引用其他包中的函数时使用的两个冒号。