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


73

我想知道是否有一种方法可以link在尝试使用编写新软件包的文档时从其他软件包运行roxygen2。像\link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}什么?


14
\code{\link[MASS]{stats}}这里尝试,(向下滚动)。
joran 2014年

谢谢。MB,你知道我在哪里能找到的roxygen2文档参数,如什么是代表一个完整的清单@param@family左右吗?有许多我在任何地方都找不到有关它们的信息。例如
MarcinKosiński2014年

Answers:



17

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

markdown语法适用于在生成的.Rd文件中[foo::bar()]转换 为的链接\code{\link[foo:bar]{foo::bar()}}。(请参阅Roxygen2小插图。)

请注意,您可能需要专门就降价支持通过编写把Roxygen: list(markdown = TRUE)你的DESCRIPTION文件,或者把一个#' @md评论,如果您想启用降价只针对特定的手册页。链接的小插图的顶部也对此进行了说明。(感谢@Tjebo的评论)

请注意,降价版本中有两个冒号,而Rd版本中只有一个冒号。


哇,太神奇了!谢谢
MarcinKosiński19年

1
请注意,此外,您可能需要专门打开Markdown支持(请参阅Roxygen2插图
-tjebo

11

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

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

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

要么

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

正确格式化文本。

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


3

从本书R包中

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

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

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.