2010-11-04 29 views
7

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 changé les fonctions, supprimé certaines fonctions, ajouté d'autres. Y at-il une fonction qui automatise la mise à jour des fichiers Rd?Existe-t-il un moyen de mettre à jour automatiquement la documentation dans un paquet R?

mise à jour

Un joli paquet 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 d'insérer rétroactivement la documentation actuellement contenue dans .RD dans des fichiers .R. Cela semble être une approche prometteuse pour l'apprentissage de roxygen et pour la conversion de paquets en cours de développement en paquets 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 l'utilise roxygen actuellement, Rd2roxygen peut aider moi migrer.

Répondre

10

Rd2roxygen a été conçu pour aider les développeurs de paquets 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 roxygen. Dès lors, 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.

1

Non, je ne pense pas.

Mais vous pouvez réessayer package.skeleton() pour des fonctions nouvelles ou modifiées, puis fusionner manuellement.

9

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

+0

Quels sont les avantages de roxygen par rapport aux outils décrits dans "writing R extensions"? –

+0

Principalement qu'il crée les fichiers .Rd pour vous en fonction des informations supplémentaires que vous ajoutez aux fichiers source .R. –

+4

@David Un avantage très important est qu'il facilite l'écriture de la documentation immédiatement après l'écriture du code --- vous n'avez même pas besoin de changer de fichier. Ensuite, non seulement les détails importants sont frais dans votre tête, mais vous pouvez écrire les docs pendant le "woohoo! étape au lieu de la "pouah ... devoir revenir en arrière et documenter tout" étape de la production. – Sharpie