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

Question

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

当我建立＆amp;重新加载包，我没有在包的文档页面中获得Rmarkdown文件标题的超链接（其中包含包的长格式文档）。我确实获得了包的DESCRIPTION文件的超链接以及所记录函数的帮助页面，但没有获取应该将人们引导到Rmarkdown文档的超链接。我想知道为什么以及我应该怎样做才能获得包的长文档的hperlink，方式类似于我在包中使用的函数的帮助页面？

Answer 1

Daragh，

您能否提供有关您所看到的错误的更多详细信息？如果代码是在github上发布的，或者你有特定的错误，那么我们可以进一步提供帮助 - 如果没有，那么我能给出的最好的建议就是在线查看Hadley Wickam的“R Packages”一书 - 这是一个很好的参考：

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

这至少可以让你很好地了解如何建立小插曲。

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

上面提到的Hadley Wickham的在线书籍......

CRAN备注

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

常见问题：

小插图以交互方式构建，但在检查时，它会因为您知道已安装的缺失软件包而失败。这意味着您忘记在DESCRIPTION中声明该依赖项（通常应该在Suggests中）。

所有内容都以交互方式工作，但在安装软件包后，小插图不会显示。可能发生了下列情况之一。首先，因为RStudio的“构建和重新加载”不会构建小插图，所以您可能需要运行devtools :: install（）。接下来检查：

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

您需要观看文件大小。如果包含大量图形，则可以轻松创建非常大的文件。没有硬性和快速的规则，但是如果你有一个非常大的小插图准备好证明文件大小，或者使它变小。