S3 generic/method consistency - 如何根据选择的类型进行调度？

Question

我正在尝试构建一个通用函数，它根据所选算法的类型分派给其他函数。在下面的示例中，算法的类型仅由 "algo1"、"algo2" 等字符选择... x 是 class S4 的对象。参数 A 和 B 对所有方法（函数）都是通用的。我想将函数命名为 Myfun.algo1 和 Myfun.algo2。这些函数有一些参数设置为一些默认值，因此有一个通用的目的。

#' @export Myfun
Myfun<-function(x, type = c("algo1", "algo2"), A, B, ...){

  switch(type,

         algo1={res<-do.call(Myfun.algo1, list(x, A, B, ...))},

         algo2={res<-do.call(Myfun.algo2, list(x, A, B, ...))},

         stop("Unknown Type"))

   return(res)
}


#' @rdname MyFun
#' @export
MyFun.algo1<-function(x, A, B, C=2, D=300){

 #Do a bit of magic.

}

#' @rdname MyFun
#' @export
MyFun.algo2<-function(x, A, B, E=10, F=1000){

 #Do more magic.

}

它有效，但是当我检查包时（使用 check()），我一直有同样的错误：

checking S3 generic/method consistency ... WARNING   
MyFun:
function(x, type, A, B, ...)   
  MyFun.algo1:
function(x, A, B, C, D)

#Same thing for algo2.

See section 'Generic functions and methods' in the 'Writing R   Extensions' manual.
Found the following apparent S3 methods exported but not registered:
MyFun.algo1 MyFun.algo2   
See section 'Registering S3 methods' in the 'Writing R Extensions'   manual.

我查看了手册，但确实没有帮助。我尝试通过添加@method 和@S3method 来更改 roxygen2 标签，但没有用。我尝试更改 ... 的顺序并将 "type" 放在 MyFun 的末尾，但都没有帮助。我不明白...我做错了什么？为什么不允许我这样做？有解决办法吗？

Answer 1

问题中的代码 MyFun 不是泛型，MyFun.algo1 和 MyFun.algo2 不是 S3 方法，尽管名称似乎暗示了这一点。最好把它改成这样的，它不暗示它不是什么，不会触发任何检查，而且更紧凑。

Myfun <- function(x, type = c("algo1", "algo2"), A, B, ...) {
  type <- match.arg(type)
  do.call(type, list(x, A, B, ...))
}

algo1 <- function(x, A, B, ...) "algo1"
algo2 <- function(x, A, B, ...) "algo2"

# test run
Myfun(1, "algo1", 2, 3)
## [1] "algo1"

# another test run
Myfun(1, A = 2, B = 3)
## [1] "algo1"

S3 generic/method consistency - 如何根据选择的类型进行调度？

S3 generic/method consistency - How to dispatch according to chosen type?

r

devtools

roxygen2