R 氧气 2 : How to document a function generated by another function?

Question

在我的包中，我编写了一个函数，它将一个函数作为输入并生成另一个函数。如何记录通过此类过程生成的函数？

下面是一个例子:使用函数将 sin()(接受弧度输入)转换为 sind()，后者接受度数单位的输入。

rad2deg <- function(f) {
  force(f)
  function(x) f(x / 180 * pi)
}

下面是函数的一些文档...

sind <- rad2deg(sin)

rad2deg 只是我的实用功能，只有我自己使用，因此没有导出也没有记录。我只需要导出 sind。但我不知道它是如何完成的，因为它甚至没有被识别为一个函数，它甚至没有一个明确的参数(当然它隐含地接受了 sin 函数的参数).因此，甚至不能使用 @param 标签。

有人知道吗？

Answer 1

它有效。以下代码为 sind 函数生成一个 Rd 文件和 NAMESPACE 指令。

rad2deg <- function(f) {
  force(f)
  function(x) f(x / 180 * pi)
}

#' sin for degrees
#' @param x an angle in degrees
#' @return sin(x)
#' @export
sind <- rad2deg(sin)