Existe-t-il un moyen de mettre automatiquement à jour la documentation d'un paquet R ?

Question

J'ai utilisé 'package.skeleton()' pour générer des fichiers d'aide .rd il y a quelques mois. J'ai édité ces fichiers, et j'ai également modifié les fonctions, supprimé certaines fonctions, ajouté d'autres. Existe-t-il une fonction permettant d'automatiser la mise à jour des fichiers Rd ?

mise à jour

Un paquet sympa vient d'être publié, intitulé Rd2roxygen Il est décrit par l'auteur Yihui Xie sur son site web. blog .

Comme son nom l'indique, ce paquet permet d'insérer rétroactivement la documentation actuellement contenue dans les fichiers .Rd dans les fichiers .R. Cela semble être une approche prometteuse à la fois pour l'apprentissage de Roxygen et pour la conversion de paquets actuellement en développement en paquets R. Woo hoo. Merci Yihui !

D'après les réponses de Joshua et de Yihui, la réponse semble être : roxygen permet la mise à jour automatique des fichiers Rd, etc. en fonction des modifications apportées au code source .R. Si je n'utilise pas roxygen actuellement, Rd2roxygen peut m'aider à migrer.

Answer 1

Rd2roxygen a été conçu pour aider les développeurs de paquets qui ont été "coincés" dans les fichiers Rd bruts mais qui veulent passer à roxygen -- il peut traiter les fichiers Rd et mettre à jour les scripts R avec les commentaires de roxygen. A partir de là, vous pouvez commencer à profiter de la puissance de roxygen . Donc Rd2roxygen n'est pas une réponse directe, mais elle pourrait vous aider à faire la transition.

Answer 2

Cela ne répond pas spécifiquement à votre question, mais vous pourriez être intéressé par les éléments suivants Roxygen .

Answer 3

Non, je ne pense pas.

Mais vous pouvez essayer de réexécuter package.skeleton() pour les fonctions nouvelles ou modifiées, puis fusionner le tout à la main.