J'ai utilisé 'package.skeleton ()' pour générer des fichiers d'aide .RD il y a quelques mois. J'ai modifié ces fichiers et j'ai également modifié les fonctions, supprimé certaines fonctions, ajouté d'autres. Existe-t-il une fonction qui automatise la mise à jour des fichiers RD?
mise à jour
Un joli emballage n'était que publié appelé rd2roxygen , il est décrit par l'auteur Yihui Xie sur son blog .
Comme le nom l'indique, ce package permet d'insérer rétroactivement la documentation actuellement contenue dans les fichiers .r. Cela ressemble à une approche prometteuse pour l'apprentissage de Roxygen et de convertir des packages actuellement en développement sur les forfaits r. Woo hoo. Merci yihui!
basé sur les réponses de Joshua et Yihui, la réponse semble être la suivante: Roxygen permet une mise à jour automatique des fichiers RD, etc. sur la base des modifications de la source .r code, et si je n'utilise pas Roxygen Actuellement. , RD2roxygen peut m'aider à migrer.
3 Réponses :
Non, je ne pense pas.
Mais vous pouvez essayer de réexécuter package.skeleton () pour des fonctions nouvelles ou modifiées, puis fusionnez ceci à la main.
Cela ne répond pas spécifiquement à votre question, mais vous pouvez être intéressé par Roxygen .
Quels sont les avantages de Roxygen sur les outils décrits dans «Écriture R Extensions»?
Principalement qu'il crée les fichiers .RD pour vous en fonction des informations supplémentaires que vous ajoutez aux fichiers source .r.
@David Un avantage très important est qu'il facilite la rédaction de la documentation immédiatement après avoir écrit le code --- Vous n'avez même pas besoin de changer de fichiers. Ensuite, non seulement les détails importants sont frais dans votre tête, mais vous pouvez écrire les docs pendant le "woohoo! Écrire un nouveau code!" Étape au lieu de "Ugh ... doit revenir en arrière et tout documenter" étape de la production.
rd2roxygen a été conçu pour aider les développeurs de colis qui ont été "bloqués" dans les fichiers RD bruts, mais veulent basculer sur Roxygen - il peut traiter les fichiers rd et mettre à jour les scripts r avec les commentaires de Roxygen. À partir de là, vous pouvez commencer à profiter de la puissance de roxygen . Donc, rd2roxygen n'est pas une réponse directe, mais cela pourrait vous aider avec la transition.