如何记录调用相同函数但具有不同参数的函数？

Question

我正在编写一个包，它有一个其他几个导出函数使用的内部函数，但导出的函数都有不同的参数。

这里是我的意思的简化：

general <- function(...) {
  # do something based on which function was called
}
one <- general
two <- general

我知道这可能看起来很奇怪，但是别名为 general 的所有函数都使用完全相同的代码，但它们具有不同的参数。所以我可能会打电话给one(id = "foo") 或two(class = "bar")。

我的问题是我如何使用 roxygen 以 R CMD check 不会抱怨的方式记录这些函数？

我想用适当的参数记录每个函数，所以这是我希望能够使用的：

general <- function(...) {
  # do something based on which function was called
}
#' @param id The id
#' @export
one <- general
#' @param class The class
#' @export
two <- general

但是当我检查我的包裹时会收到警告，例如

* checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'one'
  '...'
Documented arguments not in \usage in documentation object 'one':
  'id'

以及two 函数的类似警告。

我尝试手动编辑 .Rd 文件以进行更改

\usage{ one(...) }

进入

\usage{ one(id) }

尝试修复此警告，但当我运行检查时，它似乎再次创建文档并覆盖我的更改。

有解决办法吗？

谢谢

Answer 1

拥有实际上都是同一个函数的别名的想法似乎令人困惑，并且在这种安排中没有办法生成通过R CMD check 的标准 R 文档。

更好的方法是将函数 one 和 two 编写为 general 的包装器，可以将参数传递给它，而不是作为别名。通过这种方式，您可以为他们提供实际参数，您可以使用标准 Rd 标记（或 roxygen，如果这是您生成文档的方式）进行记录。从最终用户的角度来看，这会更加清晰，并且对于您作为开发人员的设计来说应该不会变得更加困难。

编辑：根据您的评论，这可以按如下方式工作：

general <- function(..., from) {
    if(from == "one") {
        # do stuff
    } else if (from == "two") {
        # do other stuff
    }
}

one <- function(...) {
    general(..., from = "one")
}

two <- function(...) {
    general(..., from = "two")
}

这样你可以不依赖match.call就知道最初调用了哪个函数，这看起来真的很危险，并且仍然能够以完整并通过@987654329的方式记录函数one和two @。