记录现有泛型的新 S4 方法

Question

我想记录 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)
                   })

我已经看过以下类似的帖子，但无法适应我的问题：

New method for plot - how to export?

How to properly document S4 "[" and “[<-“ methods using roxygen?

我已经尝试使用 @rdname 和 @alias。

Answer 1

我自己找到了问题的答案，它在没有警告的情况下运行 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, ...)
                   })

显然，现有泛型中未使用的参数必须设置为 setMethod 中的 "missing"。

记录现有泛型的新 S4 方法

Document new S4 method for an existing generic

r

roxygen

s4

roxygen2