使用Roxygen2参考包装晕影

时间:2014-03-26 00:26:17

标签: r knitr r-markdown roxygen2

所以,我想在函数的roxygen2评论中引用我的一个包装晕影,但我很难理解如何去做。

更一般地说,我们如何引用/inst/doc内的文件?例如。我想在/inst/doc/mypdf.pdf的roxygen2评论中引用myFunc。那会是什么样的?它甚至可能吗?

2 个答案:

答案 0 :(得分:8)

我只是告诉别人运行打开小插图的代码:

#' For more details see the help vignette:
#' \code{vignette("help", package = "mypkg")}

答案 1 :(得分:6)

我知道这是4岁...并且hadley提供了答案...但是我想提供另一种选择:

\href{../doc/help.html}{\code{vignette("help", package = "mypkg")}}

这提供了直接打开小插图的链接,并提供了代码来向用户展示如何自行打开小插图。