Мой пакет имеет функцию закрытия, которая принимает функцию в качестве параметра и возвращает другую функцию, которая выполняет несколько операций в соответствии с переданной функцией.Вот пример:
#' @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, чтобы сказать пользователю, как использовать созданную функцию (т.е. чтоэто аргументы a
и b
, что он возвращает и т. д.)
Есть ли какая-либо функция в roxygen2
или какая-либо другая опция, которая помогает мне документировать возвращаемую функцию?