氧气警告::缺少名称

Pet*_*ark 5 roxygen2

因此,我尝试使用roxygen2记录我的代码。不幸的是,我的主管感到它在全球环境中具有如此众多的功能而混乱不堪。因此,有人告诉我将它们隐藏在子环境中。这似乎阻止了氧气正确地检测到它们。下面的最小示例。

my_env <- new.env()

#' test
#' 
#' more test
#' 
#' @return none
my_env$my_func <- function(){}
environment(my_env$my_func) <- my_env
Run Code Online (Sandbox Code Playgroud)

我在devtools中使用Document()命令来构建文档。但是,我一直收到错误消息“警告:min_examp.R:8:缺少名称”。鉴于我认为我不会被允许将功能放回原来的状态,然后再将它们隐藏起来,有人对如何获取氧气来检测我的功能有任何建议吗?

use*_*745 5

roxygen2 找不到您的函数名称。

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

#' @name name_of_your_function
Run Code Online (Sandbox Code Playgroud)


Pet*_*ark 3

我终于能够通过执行以下操作来解决此问题

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
Run Code Online (Sandbox Code Playgroud)