应该在github包回购中有一个'package'子文件夹

时间:2013-03-10 16:40:15

标签: r package devtools

我使用devtools开发了一个小R包并将其放在github(https://github.com/paulhurleyuk/PaulHurleyMisc)上。我用这个结构创建了它

PaulHurleyMisc\
    R\
    data\
    man\

因为它是一个git存储库,根目录中还有一个.git文件夹,当我做R CMD Check R抱怨可执行文件时。

我应该在包的根目录下创建一个子文件夹吗?我没有尝试使用devtools从github安装,那么devtools会期待什么?

2 个答案:

答案 0 :(得分:4)

如果您先检查R CMD build然后在tarball上运行R CMD check,我认为您将摆脱警告/错误(这是建议的做法:http://cran.r-project.org/doc/manuals/r-release/R-exts.html#Checking-packages)。我认为您实际上不需要将.git等放在.Rbuildignore中,因为R现在会自动忽略.git,.svn等文件:请参阅https://github.com/wch/r-source/blob/trunk/src/library/tools/R/utils.R的第454行(这有已经true for a while

正如@hadley在下面的评论中指出的那样,devtools会自动遵循这条路线(即它构建tarball然后检查它而不是直接检查目录)

另见:Blacklist .git folder in R CMD check

答案 1 :(得分:3)

一切看起来都不错。如果您在使用R CMD时遇到抱怨,可以通过将相应的文件/文件夹添加到.Rbuildignore文件中轻松告诉R忽略某些内容