R中如何为多个S4类创建同名方法并解决devtools::document()报错
问题解决方法
你遇到的报错核心原因是重复定义了S4泛型函数:parameters和parameters<-作为全局泛型只需要定义1次,你在两个类的代码里各定义了一次,第二次的定义会覆盖第一次的泛型,导致之前注册的Myclass类方法找不到对应的泛型,触发文档生成报错。
不需要修改方法名称,按以下步骤调整即可:
具体修改方案
步骤1:单独定义全局泛型
新建一个独立的R文件(建议命名为R/00_generics.R,前缀数字保证R会优先加载该文件,避免后续方法找不到泛型),仅在该文件中定义一次泛型:
#' Access model parameters #' #' Generic function to get or set parameters of model objects #' #' @param object A model object #' @param value A named list of parameters to assign #' @return Getter returns list of parameters; setter returns updated model object. #' @export #' @rdname parameters-methods setGeneric('parameters', function(object) standardGeneric('parameters')) #' @rdname parameters-methods #' @export setGeneric('parameters<-', function(object, value) standardGeneric('parameters<-'))
步骤2:删除两个类代码中的重复泛型定义
分别修改Myclass和Mynewclass的代码,移除所有setGeneric('parameters')、setGeneric('parameters<-')调用,以及重复的别名配置,仅保留类定义和方法实现:
修改后的Myclass代码示例
#' Example docstring of Myclass #' #' @slot parameters_names names of the parameters which are used by the #' model. #' @slot parameters parameters which are used by the #' model. #' #' @import tidyverse #' @import reshape2 #' @importFrom methods new #' @export Myclass #' Myclass <- setClass('Myclass', slots = c( parameters_names = 'list', parameters = 'list' ), prototype = list( parameters_names = list('a', 'b'), parameters = vector(mode = "list", length = 2) ) ) #' @describeIn parameters-methods Retrieves parameters of Myclass. #' @export setMethod('parameters', 'Myclass', function(object) object@parameters) #' @describeIn parameters-methods Sets parameters of Myclass. #' @param value a named list of `a` and `b`. #' @export setMethod( 'parameters<-', 'Myclass', function(object, value) { a = value$a b = value$b ic <- list(a, b) object@parameters <- ic return(object) })
修改后的Mynewclass代码示例
#' Example docstring of Mynewclass #' #' @slot parameters_names names of the parameters which are used by the #' model. #' @slot parameters parameters which are used by the #' model. #' #' @import tidyverse #' @import reshape2 #' @importFrom methods new #' @export Mynewclass #' Mynewclass <- setClass('Mynewclass', slots = c( parameters_names = 'list', parameters = 'list' ), prototype = list( parameters_names = list('a', 'b', 'c'), parameters = vector(mode = "list", length = 3) ) ) #' @describeIn parameters-methods Retrieves parameters of Mynewclass. #' @export setMethod('parameters', 'Mynewclass', function(object) object@parameters) #' @describeIn parameters-methods Sets parameters of Mynewclass. #' @param value a named list of `a`, `b` and `c`. #' @export setMethod( 'parameters<-', 'Mynewclass', function(object, value) { a = value$a b = value$b c = value$c ic <- list(a, b, c) object@parameters <- ic return(object) })
额外注意事项
- 不要手动添加
@aliases parameters,ANY,ANY-method这类别名配置,roxygen2会自动生成正确的别名,手动配置容易引发冲突 - 如果你不想单独创建泛型文件,也可以将泛型定义放在
Myclass代码的最开头,只要保证整个包内泛型仅定义一次即可
修改完成后重新运行devtools::document()即可正常生成文档,不需要改动原有方法名称。
内容的提问来源于stack exchange,提问作者ibo
相关产品推荐
相关产品推荐

