Comment écrivez-vous la documentation de votre forfait? [fermé]

StackOverflow https://stackoverflow.com/questions/3086081

Question

Je n'ai pas tout à fait compris un flux de travail raisonnable pour la construction de paquets et d'écrire leur documentation.

Je veux autant du processus (et la documentation) possible de générer automatiquement.

La façon évidente de faire cela semble être d'utiliser package.skeleton pour créer les fichiers de package de base, puis remplacer le programme fichier DESCRIPTION et les fichiers Rd. Le problème avec ceci est que vous perdez alors les champs générés automatiquement que vous assurer que vous avez pensé à documenter tous les bons paramètres.

Je voudrais savoir comment aller sur la construction de paquets et rédaction de documentation. Y a-t-il des outils disponibles pour rendre le processus plus facile? ( roxygen On dirait qu'il a été conçu pour ce genre de chose ;? est-il un bon tutoriel pour et sont-il des alternatives)

Était-ce utile?

La solution

J'utilise roxygen pour tous mes projets. Pour un exemple, parcourir la source le paquet webvis . Hadley utilise également roxygen pour sa documentation (par exemple voir son lubridate ).

Au meilleur de ma connaissance, roxygen n'est pas documenté bien au-delà du vigette (jetez un oeil à la roxygen page d'accueil ).

Roxygen est bonne car elle conduit à la programmation littéraire, en ce sens que la documentation et le code sont côte à côte. Cela rend également le processus de documentation un peu plus facile puisque vous travaillez avec tout à la fois. Je le recommande vraiment, et ne développeront pas de paquets sans à ce stade.

Cela dit, il n'automatise pas la documentation dans le sens que certains outils de documentation génération font (par exemple javadoc): interprète roxygen R commentaires qui sont correctement mis en forme, mais il n'interprète pas le code R de quelque manière que <. / p>

En ce qui concerne la création du package général: package-skeleton est idéal pour commencer. Une fois que vous avez créé quelques paquets que vous pouvez trouver plus facile à l'avenir juste pour créer tous les répertoires, NAMESPACE, etc. à la main. Surtout si vous allez suivre quelques-unes des autres pratiques, comme un répertoire comprenant de démonstration, en utilisant roxygen, écrire une vignette, ou y compris le code source dans d'autres langues.

Enfin, je gère mes paquets dans Eclipse (StatET); beaucoup des années IDE ont vue « projet » qui aide pour gérer la structure de l'emballage, de sorte que vous pouvez également utiliser un éditeur plus avancé.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top