Cómo documentar adecuadamente S4 “[” y “[<-” métodos usando roxygen?
Pregunta
A continuación he publicado un mini ejemplo en el que yo quiero hacer la documentación de escritura para
un método “[“
para una clase S4. ¿Alguien sabe cómo documentar correctamente un método para la "["
genérico utilizando roxygen y S4?
Recibo una advertencia cuando se comprueba el paquete después de la construcción (véase más adelante).
#' 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")
}
)
Extracto de verificación del paquete:
* 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'.
Solución
A partir de roxygen2> 3.0.0, ya no arounds de trabajo necesario y solo necesitará:
#' Extract parts of testClass.
#'
setMethod("[", signature(x = "testClass", i = "ANY", j="ANY"),
function (x, i, j, ..., drop){
print("void function")
}
)
Otros consejos
Finalmente lo descubrió más o menos. Al menos funciona ahora:
#' 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")
}
)
Por lo que vale, en el caso de una función de reemplazo, usted querrá algo como lo siguiente:
#' An S4 class that stores a list.
#' @export
setClass("testClass",
representation(a="list"))
#' 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) {
x@a[i]
}
)
#' replace names of testClass
#'
#' @name [
#' @aliases [<-,testClass-method
#' @docType methods
#' @rdname extract-methods
setReplaceMethod("names", signature(x = "testClass", value = "ANY"), definition = function (x, value) {
names(x@a) <- value
x
})
Licenciado bajo: CC-BY-SA con atribución
No afiliado a StackOverflow