我想知道当我尝试使用roxygen2 为新包编写文档时，是否存在link 可以从其他包中运行的方法。
\link{pck=PACKAGE_NAME, fun=FUNCTION_NAME} 之类的东西？
【问题讨论】：
\code{\link[MASS]{stats}}，从here（向下滚动）。
@param 或 @family 的代表什么？有很多我无法在任何地方找到有关它们的信息。 For example:
标签： r documentation roxygen2
您必须输入 \link[pkg]{function} 例如\link[stringi]{stri_c}
【讨论】：
Roxygen2 现在还支持用 Markdown 编写的文档。
链接的降价语法是[foo::bar()]，它被翻译成
\code{\link[foo:bar]{foo::bar()}} 在生成的 .Rd 文件中。 （见Roxygen2 vignette。）
请注意，您可能需要通过在您的 DESCRIPTION 文件中写入 Roxygen: list(markdown = TRUE) 来专门打开 Markdown 支持，或者如果您只想为特定的手册页启用 Markdown，请添加 #' @md 注释。这也在链接的小插图的最顶部进行了解释。 （感谢@Tjebo 的评论）
注意，markdown 版本有两个冒号，而 Rd 版本只有一个冒号。
【讨论】：
使用.Rd 语法（"R packages" book）：
\code{\link{function}}- 此包中的函数。\code{\link[MASS]{abbey}}- 另一个包中的函数。\link[=dest]{name}- 链接到目标，但显示名称。\code{\link[MASS:abbey]{name}}- 链接到另一个包中的函数，但显示名称。\linkS4class{abc}- 链接到 S4 课程。
使用降价（roxygen2 vignette）
| roxygen2 comment | description | generated Rd code |
|---|---|---|
[func()] |
func() in this package |
\code{\link[=func]{func()}} |
[pkg::func()] |
func() in the pkg
|
\code{\link[pkg:func]{pkg::func()}} |
[thing] |
topic in this package | \link{thing} |
[pkg::thing] |
topic in the pkg
|
\link[pkg:thing]{pkg::thing} |
[`thing`] |
topic in this package | \code{\link{thing}} |
[`pkg::thing`] |
topic in the pkg
|
\code{\link[pkg:thing]{pkg::thing}} |
记得将 Roxygen: list(markdown = TRUE) 放在说明中
可从 roxygen2>=6.0.0
【讨论】：
除了potockan的回答：
一些软件包在一个帮助页面中记录了多个功能。例如，Bioconductor 包GenomicRanges 中的trim 函数记录在intra-range-methods 中（这也是来自其他包的帮助页面的名称，例如IRanges）。
要使用roxygen2 链接到正确的页面，您可以使用：
\link[GenomicRanges:intra-range-methods]{trim}
或
\code{\link[GenomicRanges:intra-range-methods]{trim}}
正确格式化文本。
帮助页面只会显示trim，但会链接到正确的帮助页面。
【讨论】：
dplyr dplyr_tidy_seelct 页面时，这很有帮助。 \code{\link[dplyr::dplyr_tidy_select]{tidy-select} 导致警告和链接断开，但 \code{\link[dplyr:dplyr_tidy_select]{tidy-select} 有效。