r - 在构建和重新加载 R 包时显示小插图链接

Question

我创建了一个 vigentte我通过运行代码 devtools::use_vignette("my-vignette") 开发的 R 包的文件夹。我正在使用 Rmarkdown 和 knitr 包。

当我构建并重新加载包时，我没有在包的文档页面中获得 Rmarkdown 文件(包含包的长格式文档)标题的超链接。我确实获得了包的 DESCRIPTION 文件的超链接以及记录功能的帮助页面，但没有将人们引导到 Rmarkdown 文档的超链接。我想知道为什么以及我应该怎么做才能以类似于我为包中使用的功能的帮助页面获取它的方式获取包的长格式文档的 hperlink？

Answer 1

达拉格，

您能否提供有关所见错误的更多详细信息？如果代码发布在 github 上或者您有特定的错误，那么我们可能会提供进一步的帮助——如果没有，那么我能提供的最佳建议是在线查看 Hadley Wickam 的“R Packages”一书——这是一个很好的引用:

http://r-pkgs.had.co.nz/

这至少会让您对如何构建小插图有一个很好的了解。

http://r-pkgs.had.co.nz/vignettes.html

来自上面引用的 Hadley Wickham 的在线书籍...

---

CRAN 笔记

请注意，由于您在本地构建小插图，因此 CRAN 仅接收 html/pdf 和源代码。但是，CRAN 不会重新构建小插图。它只检查代码是否可运行(通过运行它)。这意味着小插图使用的任何包都必须在描述中声明。但这也意味着即使 CRAN 没有安装 pandoc，您也可以使用 Rmarkdown(它使用 pandoc)。

常见问题:

vignette 以交互方式构建，但在检查时，它失败并出现有关您知道已安装的丢失包的错误。这意味着您忘记在 DESCRIPTION 中声明该依赖项(通常它应该放在 Suggests 中)。

一切都以交互方式工作，但安装包后小插图不会显示。可能发生了以下情况之一。首先，因为 RStudio 的“构建和重新加载”不构建小插图，您可能需要运行 devtools::install() 来代替。下一步检查:

• 该目录名为 vignettes/而不是 vignette/。
• 检查您是否无意中排除了带有 .Rbuildignore 的小插图
• 确保您拥有必要的插图元数据。
• 如果使用 error = TRUE，则必须使用 purl = FALSE。

您需要注意文件大小。如果包含大量图形，则很容易创建一个非常大的文件。没有硬性规定，但如果您有一个非常大的小插图，请准备好证明文件大小合理或将其变小。