DI-UMONS : Dépôt institutionnel de l’université de Mons

Recherche transversale
(titres de publication, de périodique et noms de colloque inclus)
2013-08-31 - Article/Dans un journal avec peer-review - Anglais - 20 page(s)

Hocking Toby Dylan, Wutzler Thomas, Ponting Keith, Grosjean Philippe , "Sustainable, extensible documentation generation using inlinedocs" in Journal of Statistical Software, 54, 6, 1-20

  • Edition : University of California at Los Angeles, Los Angeles (CA)
  • Codes CREF : Logiciel d'application (DI2574), Analyse de systèmes informatiques (DI2572)
  • Unités de recherche UMONS : Ecologie numérique des milieux aquatiques (S807)
  • Instituts UMONS : Institut de Recherche sur les Systèmes Complexes (Complexys)
Texte intégral :

Abstract(s) :

(Anglais) This article presents inlinedocs, an R package for generating documentation from com- ments. The concept of structured, interwoven code and documentation has existed for many years, but existing systems that implement this for the R programming language do not tightly integrate with R code, leading to several drawbacks. This article attempts to address these issues and presents 2 contributions for documentation generation for the R community. First, we propose a new syntax for inline documentation of R code within comments adjacent to the relevant code, which allows for highly readable and maintain- able code and documentation. Second, we propose an extensible system for parsing these comments, which allows the syntax to be easily augmented.

Mots-clés :
  • (Anglais) literate programming
  • (Anglais) R
  • (Anglais) Rd
  • (Anglais) documentation generation
  • (Anglais) documentation