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

前端 未结 3 1583
借酒劲吻你
借酒劲吻你 2020-12-14 02:33

Below I posted a mini example in which I want do write documentation for an “[“ method for a S4 class. Does someone know how to properly document a method for t

3条回答
  •  孤街浪徒
    2020-12-14 02:57

    I finally figured it out more or less. At least it works now:

    #' An S4 class that stores a string.
    #' @slot a contains a string
    #' @export
    setClass("testClass", 
         representation(a="character"))
    
    #' extract parts of testClass
    #'
    #' @name [
    #' @aliases [,testClass-method
    #' @docType methods
    #' @rdname extract-methods
    #'
    setMethod("[", signature(x = "testClass", i = "ANY", j="ANY"),
        function (x, i, j, ..., drop){
           print("void function")
        }
    )
    

提交回复
热议问题