[en] 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.
Disciplines :
Computer science
Author, co-author :
Hocking, Toby Dylan
Wutzler, Thomas
Ponting, Keith
Grosjean, Philippe ; Université de Mons > Faculté des Sciences > Service d'Ecologie numérique
Language :
English
Title :
Sustainable, extensible documentation generation using inlinedocs
Publication date :
31 August 2013
Journal title :
Journal of Statistical Software
ISSN :
1548-7660
Publisher :
University of California at Los Angeles, Canada
Volume :
54
Issue :
6
Pages :
1-20
Peer reviewed :
Peer Reviewed verified by ORBi
Research unit :
S807 - Ecologie numérique
Research institute :
R150 - Institut de Recherche sur les Systèmes Complexes
Bengtsson H (2003). "The R. oo package-Object-Oriented Programming with References Using Standard R Code. " In K Hornik, F Leisch, A Zeileis (eds.), Proceedings of the 3rd International Workshop on Distributed Statistical Computing (DSC 2003). Vienna, Austria. ISSN 1609-395X.
Danenberg P (2011). "roxygen Vignette. "Version 2011-12-23, URL http://CRAN.R-project. org/package=roxygen.
Lamport L (1986). LATEX: A Document Preparation System. Addison-Wesley, Reading, Massachusetts.
Leisch F (2003). "Sweave, Part II: Package Vignettes. " R News, 3(2), 21-24. URL http: //CRAN.R-project.org/doc/Rnews/.
Murdoch D (2010). Parsing Rd Files. URL http://developer.R-project.org/parseRd. pdf.
Murdoch D, Urbanek S (2009). "The New R Help System. " The R Journal, 1(2), 60-65. URL http://journal.R-project.org/archive/2009-2/RJournal_2009-2_ Murdoch+Urbanek.pdf.
R Core Team (2013). R: A Language and Environment for Statistical Computing. R Foundation for Statistical Computing, Vienna, Austria. URL http://www.R-project.org/.
Rossini AJ, Heiberger RM, Sparapani RA, Maechler M, Hornik K (2004). "Emacs Speaks Statistics: A Multiplatform, Multipackage Development Environment for Statistical Analysis. " Journal of Computational and Graphical Statistics, 13(1), 247-261.
Theul S, Zeileis A (2009). "Collaborative Software Development Using R-Forge. " The R Journal, 1(1), 9-14. URL http://journal.R-project.org/2009-1/RJournal_2009-1_ Theussl+Zeileis.pdf.
Wikipedia (2013). "Comparison of Documentation Generators {pipe} Wikipedia, The Free Encyclopedia. " URL http://en.wikipedia.org/wiki/Comparison_of_documentation_ generators.