J'ai vu quelques discussions, et d'autres endroits qui concerne la manière dont cela devrait être ou seront effectuées dans les futures versions de Roxygen2. Cependant, je suis coincé. Comment dois-je aller sur la documentation d'une S4 générique, ainsi que ses méthodes, à l'aide de Roxygen2? Un exemple de travail pour une nouvelle marque générique/méthodes, ainsi qu'un exemple pour l'extension de la base S4 générique serait incroyablement utile. Je ne veux pas avoir à faire séparés (pour la plupart) redondant de la documentation pour chaque S4 méthode de la même générique.
Due diligence: J'ai traqué un exemple utile pour la fonction "extraire" de la méthode. Cependant, il semble être obsolète et incomplète pour ma question. Il utilise @fente dans la balise de documentation de classe, ce qui n'est pas (plus?) pris en charge. Il montre seulement une extension d'un core S4 méthode "[", plutôt qu'une complète Roxygen exemple, y compris la documentation de la S4 générique.
Comment documenter correctement S4 "[" et "[<-" les méthodes à l'aide de roxygen?
Si je suis entièrement d'une nouvelle S4 générique avec le titre, la description @param @return @name @aliases
@docType @rdname, puis de document de la S4 méthode avec juste la correspondante @name @aliases
@docType @rdname, j'ai le R CMD check avertissement:
* checking for missing documentation entries ... WARNING
Undocumented S4 methods:
<< long list of apparently undocumented methods. E.g. generic 'plot' and siglist 'myClass1,ANY' >>
All user-level objects in a package (including S4 classes and methods)
should have documentation entries.
Il regarda d'abord comme si aucun de mes S4 méthodes décrites dans ce mode avec roxygen2 avait effectivement travaillé. Cependant, jusqu'à présent, j'ai remarqué que mes extensions de la base de la méthode "afficher" ne sont pas associés à une erreur, même si elles ont été documentés exactement de la même manière que le reste. Voici un exemple complet de l'roxygen documentation j'ai inclus ci-dessus l'un de l'montrent que les méthodes, qui n'ont PAS donné le manque de documentation d'erreur:
#' @name show
#' @aliases show,myClass2-method
#' @docType methods
#' @rdname show-methods
Donc, je suis à une perte. Comme vous pouvez le voir, j'ai inclus la convention des alias pour les S4 méthodes décrites dans la S4 section documentation du package R manuel, à savoir que les méthodes doivent avoir un alias avec le nom suivant (sans espace):
generic,signature_list-method.
D'une certaine manière, ce n'est pas complètement compris par R CMD check.
Enfin, après la création de la documentation à l'aide de:
library("devtools")
library("roxygen2")
document("mypkgname")
check_doc("mypkgname")
et de la construction du paquet, je reçois le fonctionnement de la documentation. Tous les titres à partir d'une méthode spécifique à la documentation de vents dans le champ "Description", plutôt maladroitement. Donc roxygen2 n'a évidemment quelque chose avec chaque méthode de la documentation et de l'est sur la bonne voie. Cependant, il n'est pas suffisant pour éviter une importante et préoccupante d'avertissement de
> R CMD check mypkgname
J'ai regardé la Rd fichiers, mais je sais encore moins sur eux pour voir rapidement ce qui est le problème, et de toute façon je veux savoir le roxygen2 solution afin que je ne vais pas avoir à manipuler la Rd fichiers directement après chaque révision de la documentation.
C'est donc un multipart question:
Quel est l'approche recommandée pour les S4 générique et S4 documentation de la méthode avec roxygen2?
Est-il un bon exemple disponible quelque part qui montre les détails complets?
Ce qui pourrait être la cause, et la solution, à la mise en garde que la documentation pour la plupart S4 méthodes est manquant (même si les méthodes avec des "disparus" de la documentation en réalité ont eu leur doc analysé par roxygen2 et de la Rd fichiers sont au moins assez bon pour travailler dans le paquet après l'
R CMD build mypkgname) ?
