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：缺少名称”。鉴于我认为我不被允许将功能放回原来的状态，然后再将它们隐藏起来，有人对如何使用氧气检测我的功能有何建议？

Answer 1

我终于可以通过执行以下操作

来解决此问题

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

Answer 2

roxygen2找不到函数的名称。

像这样为您的函数提供一个名称

#' @name name_of_your_function

Answer 3

我能够通过测试R文件夹中的所有功能是否可以正确运行来解决此问题。与“ min_examp.R”相关的所有错误功能都可能会产生“ MISSING NAME”错误。

Answer 4

您不需要@name和@usage吗？您是否找到了一种方法来处理roxygen2的完整文档？

roxygen警告：：缺少名称

4 个答案: