Как правильно документировать методы S4 «[» и «[<-« с использованием roxygen?

Ниже я разместил мини-пример, в котором хочу написать документацию для метод «[« для класса S4. Кто-нибудь знает, как правильно задокументировать метод для общего "[" с помощью roxygen и S4?
Я получаю предупреждение при проверке пакета после сборки (см. Ниже).

#' An S4 class that stores a string.
#' @slot a contains a string
#' @export
setClass("testClass", 
         representation(a="character"))

#' extract method for testClass
#'
#' @docType methods
#' @rdname extract-methods
setMethod("[", signature(x = "testClass", i = "ANY", j="ANY"),
         function (x, i, j, ..., drop){
             print("void function")
         }
)

Выдержка из проверки пакета:

* checking for missing documentation entries ... WARNING
Undocumented S4 methods:
  generic '[' and siglist 'testClass'
All user-level objects in a package (including S4 classes and methods)
should have documentation entries.
See the chapter 'Writing R documentation files' in manual 'Writing R Extensions'.
18
задан llrs 11 January 2019 в 15:08
поделиться