R CMD build at：：build()(在顶层找到的非标准文件/目录)

Question

我正在编写一个R包，并用以下方法构建和测试它：

Rscript -e "devtools::document()" && R CMD build . && Rscript -e "devtools::test();devtools::check()"

我收到一张纸条：

checking top-level files
   Non-standard file/directory found at top level:
     ‘PosteriorBootstrap_0.0.1.tar.gz’

我知道devtools::check()是第一还是第二。

这个帖子建议：

注释告诉您，通常不应该在包的顶层有一个名为build的文件。

tar.gz文件是由R CMD build创建的，即使在运行之前删除它，我也会得到相同的错误。

这个帖子建议将tar.gz文件添加到.Rbuildinore中，以删除注释。

另一种删除它的方法是运行devtools中的所有内容：

Rscript -e "devtools::document(); devtools::build(); devtools::load_all('.'); devtools::test(); devtools::check()"

然后我就不明白那张纸条了。

R CMD build和devtools::build()之间有什么区别?为什么前者会抛出这张纸条？

Answer 1

您正在组合多个执行类似和/或竞争功能的步骤。我建议阅读这以获得最佳实践的build和check工作流。

当您运行R CMD build时，它会将包构建到当前目录，该目录是顶级包目录。因此，当您运行检查时，它会在包根中看到.tar.gz文件，这是包中要包含的一个非标准文件，因此是警告。devtools::build()是智能的，它将包构建到包父目录(不管您从哪里调用它)。尝试将R CMD命令与devtools函数混合调用可能会产生问题，因为devtools也调用R CMD命令，因此您可能在不同的时间点重复操作，或者导致命令以不正确的顺序调用。

根据上面的链接，最佳实践工作流是：

Rscript -e "devtools::document();devtools::check();devtools::build()"

从包根调用，您将完全避免处理R CMD。如果您想使用R CMD，它应该如下所示：

Rscript -e "devtools::document()" && cd .. && R CMD build PosteriorBootstrap && R CMD check PosteriorBootstrap*.tar.gz

从包根目录开始，然后切换到父目录。