r - 记录现有泛型的新 S4 方法
问题描述
我想为plot
泛型记录一种新方法。问题是,如何为标准泛型记录新方法。
跑步时
devtools::check(document = FALSE)
我收到警告:
Undocumented S4 methods:
generic 'plot' and siglist 'my_new_class'
这是我的代码(R 4.0.3,roxygen2 7.1.1):
#' Plot a new class
#'
#' Dummy text
#'
#' @param x An object of class \code{\link{my_new_class}}.
#' @param y Not used.
#' @param ... Plot parameters forwarded.
#' @return A plot object.
#' @export
methods::setMethod("plot",
c(x="my_new_class"),
function(x, ...){
new_plot_func(x)
})
我已经看过以下类似的帖子,但无法适应我的问题:
如何使用 roxygen 正确记录 S4“[”和“[<-”方法?
我已经尝试过使用@rdname
and @alias
。
解决方案
我自己找到了问题的答案,它在devtools::check(document = FALSE)
没有警告的情况下运行。
#' Plot a new class
#'
#' Dummy text
#'
#' @param x An object of class \code{\link{my_new_class}}.
#' @param y Not used.
#' @param ... Plot parameters forwarded.
#' @return A plot object.
#' @export
methods::setMethod("plot",
c(x="my_new_class", y="missing"),
function(x, y, ...){
new_plot_func(x, ...)
})
显然,现有泛型中未使用的参数必须设置"missing"
为setMethod
.
推荐阅读
- bluetooth - 是否有在 ble 中获取连接的远程设备名称的选项?
- javascript - 如何防止竖线中的图例在 Chart.js 中重叠?
- graphql - 使用 graphql union 返回一个包含一些空对象的数组
- php - 返回数据为空,但从模型设置时它工作
- list - 列表视图和详细视图的同步
- android - 如何在 MVVM 模式中从小部件与 db 交互
- php - 计算PHP中两个日期之间的差异?
- angular - 打字稿错误:“T”类型的参数不能分配给“数字”类型的参数?
- python - 使用 Bokeh 对数据框列进行交互式切片
- java - 无法在 Maven 项目中解析符号“TestUnit”