roxygen警告：缺少名称

Question

我正在尝试使用roxygen2来记录我的代码。不幸的是，我的主管认为在全局环境中有这么多功能会让代码杂乱无章。所以我被告知要将它们隐藏在子环境中。但这似乎会阻止roxygen正确地检测到它们。以下是一个最小化的示例。

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检测到我的函数有任何建议吗？

- Peter Clark

Answer 1

roxygen2无法找到您函数的名称。

请像这样为您的函数提供名称：

#' @name name_of_your_function

- stevec

Answer 2

我最终通过以下方法解决了这个问题。

my_env <- new.env()

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

- Peter Clark

Answer 3

我通过测试R文件夹中的所有函数是否能够无错误运行来解决了这个问题。与您的“min_examp.R”相关的任何有缺陷的函数都可能会生成MISSING NAME错误。

- yzhang