我正在使用devtools
编写R包。现在我有一个通用函数plot
,可以使用不同的类(例如plot.fact
,plot.numer
等)。在.R
的{{1}}文件中,我以漫游的方式对文档进行plot.fact
评论。除了其他项目,我还指定了以下注释:
#'
但是,当我运行#' @rdname plot
#' @method plot fact
#' @S3method plot fact
#' @export
时,会显示以下错误消息:check('pkg')
。我如何写评论有什么不对吗?或者我必须在函数Error: bad 'S3method' directive: S3method(plot)
之前写一个plot <- function(x,...) UseMethod("plot")
吗?谢谢!
更新
更准确地说,我的plot.fact
函数没有单个参数plot.fact
;相反,它有许多额外的参数来自定义绘图。参数是
x
根据哈德利的建议,我使用
plot.fact <- function(x, conf.env=0.95, data.note="", leg.cex=1, ...)
但错误仍然是#' @rdname plot
#' @method plot fact
#' @export
......我是否需要写下
bad 'S3method' directive
在定义plot <- function(x, conf.env=0.95, data.note="", leg.cex=1, ...) {
UseMethod("plot")
}
之前?谢谢!
答案 0 :(得分:1)
@method plot fact
+ @export
来记录方法。 @s3method plot fact
。 您不应该在同一个区块中拥有@method
和@s3method
。