我想知道是否有一种方法可以link
在尝试使用编写新软件包的文档时从其他软件包运行roxygen2
。像\link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}
什么?
我想知道是否有一种方法可以link
在尝试使用编写新软件包的文档时从其他软件包运行roxygen2
。像\link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}
什么?
Answers:
您必须输入 \link[pkg]{function}
例如\link[stringi]{stri_c}
Roxygen2
现在还支持以markdown编写的文档。
markdown语法适用于在生成的.Rd文件中[foo::bar()]
转换
为的链接\code{\link[foo:bar]{foo::bar()}}
。(请参阅Roxygen2小插图。)
请注意,您可能需要专门就降价支持通过编写把Roxygen: list(markdown = TRUE)
你的DESCRIPTION
文件,或者把一个#' @md
评论,如果您想启用降价只针对特定的手册页。链接的小插图的顶部也对此进行了说明。(感谢@Tjebo的评论)
请注意,降价版本中有两个冒号,而Rd版本中只有一个冒号。
除了potockan的答案之外:
有些软件包在单个帮助页面中记录了一些功能。例如,trim
Bioconductor软件包中的功能GenomicRanges记录在intra-range-methods
其中(这也是其他软件包(例如IRanges)的帮助页面的名称)。
要链接到正确的页面 roxygen2
您可以使用:
\link[GenomicRanges:intra-range-methods]{trim}
要么
\code{\link[GenomicRanges:intra-range-methods]{trim}}
正确格式化文本。
帮助页面只会显示,trim
但会链接到正确的帮助页面。
\code{\link[MASS]{stats}}
从这里尝试,(向下滚动)。