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

问题描述 投票:0回答:1

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

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

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

r packages travis-ci rcpp
1个回答
3
投票

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

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

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

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

© www.soinside.com 2019 - 2024. All rights reserved.