链接到R中roxygen2文档中的其他包
我想知道,当我试图使用链接到R中roxygen2文档中的其他包,r,documentation,roxygen2,R,Documentation,Roxygen2,我想知道,当我试图使用roxygen2为新软件包编写文档时,是否有一种方法可以将其他软件包的功能链接到上。 类似于\link{pck=PACKAGE\u NAME,fun=FUNCTION\u NAME}?除了回答: 某些软件包在单个帮助页面中记录了多个功能。例如,Bioconductor软件包中的trim功能记录在intra-range methods中(这也是其他软件包的帮助页面名称,例如) 要使用roxygen2链接到右侧页面,您可以使用: \link[GenomicRanges:intr
roxygen2
为新软件包编写文档时,是否有一种方法可以将其他软件包的功能链接到上。
类似于\link{pck=PACKAGE\u NAME,fun=FUNCTION\u NAME}
?除了回答:
某些软件包在单个帮助页面中记录了多个功能。例如,Bioconductor软件包中的trim
功能记录在intra-range methods
中(这也是其他软件包的帮助页面名称,例如)
要使用roxygen2
链接到右侧页面,您可以使用:
\link[GenomicRanges:intra-range-methods]{trim}
或
要正确设置文本格式
帮助页面将仅显示trim
,但将链接到右侧的帮助页面 Roxygen2
现在还支持以降价方式编写的文档
标记语法是用于链接的[foo::bar()]
,该链接被翻译为
生成的.Rd文件中的\code{\link[foo:bar]{foo::bar()}
。(见附件。)
请注意,您可能需要通过在说明
文件中写入Roxygen:list(Markdown=TRUE)
来专门打开标记支持,或者如果您只想为特定的手册页启用标记,则可以添加#'@md
注释。这也在链接的渐晕图的顶部进行了解释。(感谢@Tjebo的评论)
请注意,标记版本中有两个冒号,而Rd版本中只有一个冒号。本书:
\code{\link{function}
-此包中的函数
\code{\link[MASS]{abbey}
-另一个包中的函数
\link[=dest]{name}
-链接到dest,但显示名称
\code{\link[MASS:abbey]{name}
-链接到另一个包中的函数,但显示名称
\linkS4class{abc}
-链接到S4类
注意:在第四个选项中,只有一个冒号,而不是代码中引用其他包函数时使用的两个冒号。请尝试\code{\link[MASS]{stats}
,from(向下滚动)。谢谢。Mb您知道我在哪里可以找到roxygen2文档参数的完整列表,比如什么代表@param
或@family
等等?我在任何地方都找不到关于他们的信息答案很短但很有价值:)请注意中的“备选文档工作流”一章。为了查看链接,您必须重新构建包,而不仅仅是重新编写文档。哇,太棒了!!另外,您可能需要专门启用降价支持(
\code{\link[GenomicRanges:intra-range-methods]{trim}}