文档

Question

问候和致意，

我最近联系了一个包含R包的github repo到Travis CI。我认为存储库可以很好地构建，但是，有几个检查错误出现，我无法在本地安装的Windows，OS X或Ubuntu 14.04 LTS上复制。

错误源自共享以下共同的功能：

1. 拥有使用@keyword内部编码的roxygen2帮助文档。
2. 使用Rcpp / RcppArmadillo编写。

具体来说，我收到特拉维斯CI的以下警告：

  

在文档对象'internal中使用的函数或方法   在这里运行'但不在代码中：

这不是特别成问题，因为它是一个警告。 previous post使用@method和@export解决了此示例的不同形式。但是，Rcpp函数不属于OO类（S3 / S4 / RR）。

但是，当Travis CI开始评估软件包的示例时，此警告将成为错误：

  

错误：找不到函数“这里的内部函数”

并导致构建失败。但是，构建本身应该通过检查，因为函数确实存在。

使用recommended guidelines以下列方式配置Travis CI：

language: r
sudo: required
warnings_are_errors: true

r_packages:
 - ggplot2
 - devtools
 - RcppArmadillo
 - knitr
 - gridExtra
 - grid

r_build_args: "--no-build-vignettes"
r_check_args: "--no-build-vignettes --as-cran"

注意由于R代码调用了文档中列出的内部函数之一，Travis在构建它们时会出错，因此添加了--no-build-vignettes。

我相信这是最新的面向公众的建设： Travis CI report (v1.0.1)

CRAN第一版的结果： CRAN report (v1.0.0)

欢迎任何想法。

Answer 1

我可以复制笔记本电脑上的警告/错误（运行OS X）。我也很确定如果你检查你的存储库，构建tar球然后运行R CMD检查，你将得到与Travis CI相同的警告/错误。 （我假设你只从R Studio中检查了你的包裹。）

据我所知，问题是您已将R/RcppExports.R和src/RcppExports.cpp添加到.gitignore，这意味着这些文件不在GitHub上。 Travis CI不会为您运行Rcpp::compileAttributes。

有两个简单的解决方案：

1. 从.gitignore中删除R/RcppExports.R和src/RcppExports.cpp，并将其与其他所有内容一起提交给GitHub。这是有道理的，因为这些文件实际上是你的软件包的一部分，你不应该期望最终用户在安装软件包之前编译它们。我认为这是解决这个问题的正确方法。
2. 在构建程序包之前，在travis.yml中添加一行以运行Rcpp :: compileAttributes，例如： Rscript -e "Rcpp::compileAttributes()"。