使用 Roxygen2 的参考包小插曲答案

【问题标题】：Reference package vignettes with Roxygen2使用 Roxygen2 的参考包小插曲
【发布时间】：2014-05-04 03:42:20
【问题描述】：

所以，我想在函数的 roxygen2 cmets 中引用我的一个包小插曲，但我很难理解如何去做。

更一般地说，我们如何引用/inst/doc 中的文档？例如。我想在 roxygen2 cmets 中为 myFunc 引用 /inst/doc/mypdf.pdf。那会是什么样子？有没有可能？

【问题讨论】：

【解决方案1】：

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

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

【讨论】：

【解决方案2】：

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

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

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

【讨论】：

如果您使用 pkgdown，我会收回此建议。 pkgdown 会将\code{vignette("help", package = "mypkg")} 直接转换为小插图文章的网址（即..使用上面推荐的内容）