Est-il possible de mettre à jour automatiquement la documentation dans un package R?

Question

J'utilise « package.skeleton () » pour générer .rd fichiers d'aide, il y a quelques mois. Je l'ai modifié ces fichiers, et je l'ai également changé les fonctions, a supprimé certaines fonctions, d'autres ajoutés. Y at-il une fonction qui permet d'automatiser la mise à jour des fichiers Rd?

mise à jour

Un paquet agréable vient de sortir appelé Rd2roxygen , il est décrit par l'auteur Yihui Xie sur son blog .

Comme son nom l'indique, ce package permet un effet rétroactif à insérer de la documentation actuellement contenue dans .rd dans des fichiers .R. Sons comme une approche prometteuse pour les roxygen d'apprentissage et pour convertir les paquets actuellement en développement pour les packages R. Woo hoo. Merci Yihui!

Sur la base des réponses de Joshua et Yihui, la réponse semble être: roxygen permet la mise à jour automatique des fichiers Rd etc en fonction des changements dans la source code .R, et si je ne suis pas actuellement en utilisant roxygen , Rd2roxygen peut me aider à migrer.

Answer 1

Rd2roxygen a été conçu pour les développeurs de paquet d'aide qui ont été « coincés » dans les fichiers Rd premières mais qui veulent passer à roxygen - il peut traiter des fichiers Rd et mettre à jour les scripts R avec des commentaires de roxygen. A partir de là, vous pouvez commencer à profiter de la puissance de roxygen. Alors Rd2roxygen n'est pas une réponse directe, mais il peut vous aider à la transition.

Answer 2

Cela ne répond pas à votre question, mais vous pouvez être intéressé par Roxygen .

Answer 3

Non, je ne pense pas.

Mais vous pouvez essayer de package.skeleton() réexécuter des fonctions nouvelles ou modifiées, puis fusionner cette main.