como documentar uma classe de referência R?
como documentar o uso de funções de membro de uma classe de referênci
se eu escrever umRd
com um\usage
block, como evito oWARNING
Functions/methods with usage in documentation object 'XmlDoc' but not in code:
$ new
Eu esperaria o\usage
loco @ para me permitir escrever coisas como:
obj <- ClassName$new(par1, par2, ...)
obj$method1(oth1, ...)
e depois documentaria os parâmetros no\arguments
quadra
Se eu fizer isso,R CMD check
reclama com
Assignments in \usage in documentation object 'ClassName':
e não reconhece os métodos como objetos de código que preciso de document
agora, estou escrevendoRd
arquivos sem o\usage
e escrevendo o código acima no\examples
, mas não tenho lugar para documentar argumentos e dessa maneira ocheck
tem muito pouco para verificar, na verdade. Como não estou satisfeito com isso, agora estou perguntando à comunidade sobre a prática comum atual.