3

我想在我的 R 包中包含静态小插曲,它将显示给使用 R 函数的用户browseVignettes()

我需要小插图是静态的,因为小插图的构建时间太长,如果动态包含它们,我会导致我无法对 win-builder 进行 CRAN 检查。

该软件包R.rsp似乎提供了我想要的东西;此处描述:https ://cran.r-project.org/web/packages/R.rsp/vignettes/R_packages-Static_PDF_and_HTML_vignettes.pdf 。

我按照R.rsp. 按照指示,我有一个vignettes文件夹,其中包含一个 .html 文件以及一个相应的 .Rmd 文件和一个 .html.asis 文件。我在说明文件中也有相应的代码。使用这些设置,我通过了 win-builder、travis 等的 CRAN 测试。但是,当我从 github 下载包时,它说没有与包关联的小插曲。我是否遗漏了有关 R.rsp 包的内容?这种能力过时了吗?我是否需要将构建的小插图从 Vignettes 文件夹复制到 inst/doc 文件夹中?(我看到有关 vignettes 文件夹与 inst/doc 文件夹的冲突信息)。

使用 R.rsp::asis 之类的东西是包含需要很长时间才能动态包含的小插曲的最佳方式吗?我见过的另一种方法是在 .Rbuildignore 中包含 vignettes 文件夹,然后在 README 文件中包含一条注释,告诉用户他们可以从 github 单独构建 vignettes 以便查看它们。我也在考虑在自述文件中包含指向外部小插图的链接。这是更好的方法吗?CRAN 可能更喜欢哪个?

4

1 回答 1

2

添加build_vignettes=TRUE到您的install_github通话中。

于 2018-09-14T23:53:02.767 回答