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

Question

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

这样的东西

Answer 1

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

Answer 2

除了potockan的答案：
一些软件包在单个帮助页面中记录了几种功能。例如，来自Bioconductor软件包GenomicRanges的trim函数记录在intra-range-methods中（这也是来自其他软件包（例如IRanges）的帮助页面的名称）。

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

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

或

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

以正确设置文本格式。

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

Answer 3

摘自R packages这本书：

• \code{\link{function}}-此软件包中的功能。
• \code{\link[MASS]{abbey}}-在另一个程序包中起作用。
• \link[=dest]{name}-链接到dest，但显示名称。
• \code{\link[MASS:abbey]{name}}-链接到另一个程序包中的功能，但显示名称。
• \linkS4class{abc}-链接到S4类。

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

Answer 4

Roxygen2现在还支持以markdown编写的文档。

该链接的markdown语法为[foo::bar()]，该链接被翻译为 \code{\link[foo:bar]{foo::bar()}}在生成的.Rd文件中。