创建新 R 包时如何正确组织小插图和 inst 文件夹

Question

在提问之前，我承认这个问题的许多部分已经在其他堆栈中触及，并且我已经阅读了 Hadley Wickham 的实例和小插图部分，但我仍在努力解决我的警告。如果这个问题有点啰嗦，我很抱歉，我会尽力彻底。

\n\n

我的问题涉及我的 package_tutorial。

\n\n

我收到的第一个警告是：

\n\n

> checking files in \xe2\x80\x98vignettes\xe2\x80\x99 ... WARNING\n  Files in the \'vignettes\' directory but no files in \'inst/doc\':\n  \xe2\x80\x98package_tutorial.Rmd\xe2\x80\x99, \xe2\x80\x98package_tutorial.pdf\xe2\x80\x99\n\n

\n\n

在 Hadley Wickham 的文档中，它指出“inst/docs：这是一个较旧的小插图约定，在现代包中应该避免。” 那么为什么 CMD 检查要求将小插图放在 inst/doc 文件夹中呢？我将概述问题末尾附近的小插图和 inst 文件夹中的内容。

\n\n

我收到的下一个警告也是如此：

\n\n

> checking package vignettes in \xe2\x80\x98inst/doc\xe2\x80\x99 ... WARNING\n  dir.exists(dir) is not TRUE\n  Package vignette without corresponding single PDF/HTML:\n     \xe2\x80\x98package_tutorial.Rmd\xe2\x80\x99\n

\n\n

我没有 doc 文件夹，因为很明显 inst/doc 文件夹已过时。当我对 inst/doc 文件夹中的小插图进行 CMD 检查时，doc 文件夹将被删除。我知道这可能是重建过程的一部分。

\n\n

可能有助于解决此问题的其他信息：

\n\n

文件夹结构（仅适用于vignette和inst文件夹）：

\n\n

包 - 安装 - extdata - package_tutorial.pdf

\n\n

包-安装-extdata-package_tutorial.Rmd

\n\n

package - inst - extdata -plots - 小插图使用的几个图

\n\n

包 - 插图 - package_tutorial.pdf

\n\n

包 - 插图 - package_tutorial.Rmd

\n\n

我尝试过不同的选项，即在 extdata 中不包含 Rmd 文件，在 vignettes 文件夹中不包含 pdf 文件，但可惜这并没有解决问题。

\n\n

YAML 元数据：

\n\n

---\ntitle: "package tutorial"\nauthor: "Krutik Patel"\noutput:\n        pdf_document: \n                keep_tex: true\n                toc: true\n                toc_depth: 5\n                fig_width: 5\n                fig_heigh: 4\n                fig_caption: true\n                df_print: kable \n                highlight: tango\n                citation_package: natbib\nvignette: >\n        %\\VignetteIndexEntry{package tutorial}\n        %\\VignetteEngine{knitr::rmarkdown}\n        \\usepackage[utf8]{inputenc}\n

\n\n

构建工具选项：\n构建并重新加载 - R CMD INSTALL 附加选项：

\n\n

--no-multiarch --with-keep.source --resave-data\n

\n\n

检查包 - R CMD INSTALL 附加选项：

\n\n

--as-cran --no-build-vignettes\n

\n\n

构建源包 - R CMD INSTALL 附加选项：

\n\n

--compact-vignettes="both"\n

\n\n

我确实希望这些信息足以帮助我解决问题。我希望这是一些我没有见过的愚蠢的事情。非常感谢任何指导帮助。

\n

Answer 1

这有点晚了，但是，当我停止在 R 包中保存构建的小插图时，错误就出现了。

相反，我在文件夹中只有 rmd 文件和相关绘图/vignette，并且有一个/inst不包含任何晕影相关材料的文件夹。