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

Rcpp integrated with R package: Documentation of CPP code objects

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

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

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

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

如果您的 NAMESPACE 包含通配符 'export all' a la exportPattern("^[[:alpha:]]+") 然后每个全局符号被导出 并且每个明确记录的 R 标准 需要一个帮助条目。

一个简单的解决方法是不导出所有内容,只为要导出的内容编写文档。我们有时会这样做并调用类似 foo_impl 的 Rcpp 函数,然后让 R 函数 foo(有文档)调用 foo_impl。在那种情况下,您只需导出 foo 就可以了。

简而言之,您对 R 包感到困惑,而不是 Rcpp。我建议下载一些(小的)Rcpp 包的 sources 来感受一下它们的作用。