logo标签列表

R Roxygen2: 如何记录由另一个函数生成的函数？

rroxygen2
3
在我的程序包中，我编写了一个函数，它将一个函数作为输入并生成另一个函数。如何对通过这种过程生成的函数进行文档化？
下面是一个示例：使用一个函数将以弧度为单位输入的sin()转换为以度为单位输入的sind()。
rad2deg <- function(f) {
  force(f)
  function(x) f(x / 180 * pi)
}

以下是有关下面函数的一些文档...

sind <- rad2deg(sin)
rad2deg 是我个人开发的一个实用函数，未被导出或文档化。我只需要导出 sind 函数，但我不知道如何做到，因为它甚至没有被识别为一个函数，也没有明确的参数（当然隐含地采用了 sin 函数的参数）。所以，连 @param 标签都无法使用。
有没有人有任何想法？
1个回答
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)
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接