使用Roxygen2参考包装晕影

Ste*_*ieP 9 r roxygen2 knitr r-markdown

所以,我想在函数的roxygen2注释中引用我的一个包装晕影,但我很难理解如何做到这一点.

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

had*_*ley 8

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

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


lde*_*cco 6

我知道这已经4岁了...哈德利提供了答案...但是我想提供另一种选择:

\href{../doc/help.html}{\code{vignette("help", package = "mypkg")}}
Run Code Online (Sandbox Code Playgroud)

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

  • 如果您使用 pkgdown,我会收回此建议。pkgdown 会将 `\code{vignette("help", package = "mypkg")}` 直接转换为 vignette 文章的 url(即..使用上面推荐的内容) (2认同)