Sustainable, Extensible Documentation Generation Using inlinedocs

Toby Dylan Hocking, Thomas Wutzler, Keith Ponting and Philippe Grosjean

Journal of Statistical Software, 2013, vol. 054, issue i06

Abstract: This article presents inlinedocs, an R package for generating documentation from comments. 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 maintainable code and documentation. Second, we propose an extensible system for parsing these comments, which allows the syntax to be easily augmented.

Date: 2013-09-08
References: Add references at CitEc
Citations:

Downloads: (external link)
https://www.jstatsoft.org/index.php/jss/article/vi ... Using_inlinedocs.pdf
https://www.jstatsoft.org/index.php/jss/article/do ... docs_2013.9.3.tar.gz
https://www.jstatsoft.org/index.php/jss/article/do ... ile/v054i06/v54i06.R
https://www.jstatsoft.org/index.php/jss/article/do ... 4i06-replication.zip

Related works:
This item may be available elsewhere in EconPapers: Search for items with the same title.

Export reference: BibTeX RIS (EndNote, ProCite, RefMan) HTML/Text

Persistent link: https://EconPapers.repec.org/RePEc:jss:jstsof:v:054:i06

DOI: 10.18637/jss.v054.i06

Access Statistics for this article

Journal of Statistical Software is currently edited by Bettina Grün, Edzer Pebesma and Achim Zeileis

More articles in Journal of Statistical Software from Foundation for Open Access Statistics
Bibliographic data for series maintained by Christopher F. Baum ().