¿Cómo documento una clase de referencia R?
¿Cómo documento el uso de las funciones miembro de una clase de referencia?
si escribo unRd
archivo con un\usage
bloque, ¿cómo evito elWARNING
Functions/methods with usage in documentation object 'XmlDoc' but not in code:
$ new
Esperaría el\usage
bloque para permitirme escribir cosas como:
obj <- ClassName$new(par1, par2, ...)
obj$method1(oth1, ...)
y luego documentaría los parámetros en el\arguments
bloque.
Si hago esto,R CMD check
se queja con
Assignments in \usage in documentation object 'ClassName':
y no reconoce los métodos como objetos de código que necesito documentar.
a partir de ahora, estoy escribiendoRd
archivos sin el\usage
bloquear y escribir el código anterior en el\examples
bloque, pero entonces no tengo lugar para documentar argumentos y de esta manera elcheck
tiene muy poco que verificar en realidad. Como no estoy satisfecho con esto, ahora le pregunto a la comunidad sobre la práctica común actual.