Roxygen2:如何记录在函数闭包中返回的函数?

时间:2019-02-19 00:17:25

标签: r closures documentation roxygen2

我的程序包有一个函数闭包,该闭包将一个函数作为参数并返回另一个函数,该函数根据传递的函数执行多项操作。这是一个示例:

#' @param operation A function to be used.
#' @return A function that has parameters 'a' and 'b' and I can't document.

create_fun <- function(operation){
  fn <- function(a,b){
    operation(a,b)*8
  }
  return(fn)
}

f1 <- create_fun(max)
f2 <- create_fun(min)
f1(1,2)
# 16
f2(1,2)
# 8

尽管roxygen2仅提供create_fun的非常简单的文档,但我不知道如何使用roxygen来告诉用户如何使用创建的函数(即其参数{{1是什么) }}和a,返回的内容,等等。

b上是否有任何功能或任何其他可以帮助我记录返回功能的选项?

0 个答案:

没有答案