如何使用 R.rsp 在 R 包中包含静态插图
How to include static Vignettes in R Package using R.rsp
我想在我的 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 文件,按照指示。我在 DESCRIPTION 文件中也有适当的代码。通过这些设置,我在 win-builder、travis 等上通过了 CRAN 测试。但是,当我从 github 下载包时,它说没有与包关联的小插图。我是否遗漏了 R.rsp 包的某些内容?这种能力过时了吗?我是否需要将构建的插图从 Vignettes 文件夹复制到 inst/doc 文件夹中? (我看到有关 vignettes 文件夹与 inst/doc 文件夹的信息相互矛盾)。
使用 R.rsp::as 之类的东西是否是包含需要很长时间才能动态包含的小插曲的最佳方式?我看到的另一种方法是在 .Rbuildignore 中包含 vignettes 文件夹,然后在 README 文件中包含一条注释,告诉用户他们可以从 github 单独构建 vignettes 以便查看它们。我也在考虑在 README 中包含指向外部小插图的链接。这是更好的方法吗? CRAN 更喜欢哪个?
将 build_vignettes=TRUE
添加到您的 install_github
通话中。
我想在我的 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 文件,按照指示。我在 DESCRIPTION 文件中也有适当的代码。通过这些设置,我在 win-builder、travis 等上通过了 CRAN 测试。但是,当我从 github 下载包时,它说没有与包关联的小插图。我是否遗漏了 R.rsp 包的某些内容?这种能力过时了吗?我是否需要将构建的插图从 Vignettes 文件夹复制到 inst/doc 文件夹中? (我看到有关 vignettes 文件夹与 inst/doc 文件夹的信息相互矛盾)。
使用 R.rsp::as 之类的东西是否是包含需要很长时间才能动态包含的小插曲的最佳方式?我看到的另一种方法是在 .Rbuildignore 中包含 vignettes 文件夹,然后在 README 文件中包含一条注释,告诉用户他们可以从 github 单独构建 vignettes 以便查看它们。我也在考虑在 README 中包含指向外部小插图的链接。这是更好的方法吗? CRAN 更喜欢哪个?
将 build_vignettes=TRUE
添加到您的 install_github
通话中。