如何正确地使用氧气记录S4“ [”方法?

尽管在2011年(How to properly document S4 methods using roxygen2)之前曾问过这个问题,但情况已经改变。经过大量的时间搜索和试验,我认为以下工作有效。




#' Define Class A
#'
#' @slot slt numeric.
#'
#' @export
#'
setClass("A",slots = c(slt="numeric")
         )



#' Subset method for A class
#'
#' @param A character: signature supported
#' @param integer character: signature supported
#' @param missing character: signature supported
#' @param x Object of account class
#' @param i integer index
#' @param j integer index
#' @param ... other arguments passed to subset
#' @param drop not used
#' @rdname A-class
#'
#'
#' @export
setMethod("[",c("A","integer","missing","ANY"),function(x,i,j,...,drop=TRUE)
          {
              methods::initialize(x,slt=x@slt[i])
          })

带有此文档的软件包将提供清晰的CMD检查。 我正在使用RStudio版本1.2.5033,R版本3.6.3(2020-02-29)和roxygen2版本7.1.0。

我发现Rstudio命令“插入roxygen骨架”或多或少对记录该方法毫无用处:它绝对不插入任何内容。

我的问题是:尽管这行得通,但我不确定它是否符合当前的最佳实践。可以改善吗?

d520y 回答:如何正确地使用氧气记录S4“ [”方法?

暂时没有好的解决方案,如果你有好的解决方案,请发邮件至:iooj@foxmail.com
本文链接:https://www.f2er.com/2596819.html

大家都在问