roxygen2 - 氧气警告 : : Missing name

Question

所以我尝试使用 roxygen2 来记录我的代码。不幸的是，我的主管觉得在全局环境中拥有如此多的功能，它很困惑。所以我被告知将它们隐藏在子环境中。这似乎阻止了氧气正确检测它们。下面是最小的例子。

my_env <- new.env()

#' test
#' 
#' more test
#' 
#' @return none
my_env$my_func <- function(){}
environment(my_env$my_func) <- my_env

我正在使用 devtools 中的 Document() 命令来构建文档。但是我不断收到错误“警告:min_examp.R:8:缺少名称”。鉴于我认为我不会被允许将这些功能恢复到隐藏它们之前的样子，有人对如何让 roxygen 检测我的功能有任何建议吗？

Answer 1

roxygen2 找不到您的函数名称。

为您的函数提供一个名称，如下所示

#' @name name_of_your_function