Rcpp与R包集成:CPP代码对象的文档

时间:2016-09-02 14:50:12

标签: r packages travis-ci rcpp

我一直在用Rcpp开发一个用于C ++集成的包。我使用RcppExport使函数返回SEXP对象。

问题是travis-ci似乎发出警告,告诉他们有未记录的代码对象。 (这些是cpp函数)。但是,我不希望用户也直接访问这些功能。

如何解决此问题?我怎样才能记录这些功能?

1 个答案:

答案 0 :(得分:3)

你似乎在这里有一个基本的误解。

如果您的NAMESPACE包含通配符'全部导出' a la exportPattern("^[[:alpha:]]+"),那么每个全局符号都会导出并且每个R标准都有明确记录需要一个帮助条目。

一个简单的解决方法是不导出所有内容,只是为要导出的内容编写文档。我们有时这样做并调用Rcpp函数,如foo_impl,然后使用R函数foo(带文档)调用foo_impl。在这种情况下,您只需导出foo,一切都很好。

简而言之,您对 R软件包感到困惑,而不是 Rcpp 。我建议下载一些(小)Rcpp软件包的来源,以了解他们的工作。