我不想导出的函数的未记录代码对象警告

Question

我正在尝试用 Rcpp 编写一个 R 包。除了R CMD check my_package 发出的警告外，一切正常。

Status: 1 WARNING
checking for missing documentation entries ... WARNING
Undocumented code objects:
  ‘shiny_function’
All user-level objects in a package should have documentation entries.

这里shiny_function是用C++实现的，并用Rcpp属性导出

// [[Rcpp::export]]
int shiny_function(int arg) {
  return arg;
}

问题是我想在导出到 R 时将其“重命名”为 shiny.function，所以在 R/shiny_function.R 我有

shiny.function <- function(arg) {
  .Call("_my_package_shiny_function", arg)
}

收到此警告后，我将NAMESPACE 修改为exportPattern("^[^_]+")，以避免导出名称中带有下划线的函数，但警告仍然存在。

如何“重命名”用 C++ 编写的 Rcpp 函数？

Answer 1

这是非常基本的：当您添加标签 [[Rcpp::export]] 时，您会得到您所要求的：一个导出的函数。而exported的意思是全局可见。

如果你不想这样，只需删除标签。您仍然可以通过.Call() 以通常的方式处理一个函数，并且您可以在 R 层做任何您想做的事情，包括重命名、参数控制和验证等等。

如果您仔细查看（我知道有很多）文档，您将在 Rcpp 属性 小插图中看到，您还可以控制导出的内容和对象（ie em> 你可以让函数对 C++ 层可见）。