roxygen2 - 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 检测我的功能有任何建议？

标签： roxygen2

Answer 1

roxygen2找不到您的函数的名称。

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

#' @name name_of_your_function