5

我已经阅读了以下两个讨论：
Roxygen2 - 如何在
使用 Roxygen 构建 R 包时正确记录 S3 方法 S3 方法一致性警告
以及以下两个教程：
http ://cran.r-project.org/doc/manuals/R-exts .html#Generic-functions-and-methods
http://adv-r.had.co.nz/S3.html，
但我的问题仍然没有解决。以下是详细信息：
我想在一个包中定义一个 plot() 泛型的 S3 方法，我的代码是：

#' description
#'
#' more details
#'
#' @param x "test" object
#' @param label parameter one
#' @param log parameter two
#' @param ... graphical parameters to plot
#'
#' @examples
#' plot(a)
#'
#' @export
plot <- function(x, label=TRUE, log=TRUE,  ...){
  UseMethod("plot")
}

#' @export
plot.test <- function(x, label=TRUE, log=TRUE, ...){
# some code
}

运行后devtools::check()，我会收到以下警告：

checking S3 generic/method consistency ... WARNING
plot:
  function(x, log, ...)
plot.test:
  function(x, label, log, ...)

See section ‘Generic functions and methods’ in the ‘Writing R
Extensions’ manual.

好像参数label消失了，我尝试交换参数log和的位置，label后面的任何参数x都会消失function(x, log, ...)，那么如何解决这个问题？

4

2 回答 2

2

R CMD check当我使用 s3 方法运行或访问我的包时，我遇到了同样的问题devtools:check()，由于 S3 泛型/方法的一致性，它总是给我警告。

我也使用 Roxygen2，我尝试在 @export 之前使用 s3 generic 将 @rdname 添加到我的函数中，它对我有用。请尝试以下代码：

##---- You can remove this---###
#plot <- function(x, label=TRUE, log=TRUE,  ...){
#  UseMethod("plot")
#}
#######################################

#' description
#'
#' more details
#'
#' @param x "test" object
#' @param label parameter one
#' @param log parameter two
#' @param ... graphical parameters to plot
#'
#' @examples
#' plot(a)
#' @rdname plot.test
#' @export
plot.test <- function(x, label=TRUE, log=TRUE, ...){
# some code
}

您可以删除第一个函数（使用 UseMethod('plot') 绘图）。

让我知道警告是否消失。

于 2019-06-08T15:42:54.480 回答
2

您是使用plot()泛型函数作为示例还是实际上是您的代码？

如果是后者，我认为这是因为它plot()是一个带有三个参数的基本 R 函数：x、y 和 ...。要让您自己的 s3 方法通过检查，无需重新定义您自己的泛型，而且您的 s3 方法必须遵循与基本 R 泛型完全相同的参数。

于 2018-03-07T06:56:28.987 回答