Sustainable, extensible documentation generation using inlinedocs

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

Research output: Contribution to journalArticlepeer-review


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.

Original languageEnglish (US)
Pages (from-to)1-20
Number of pages20
JournalJournal of Statistical Software
Issue number6
StatePublished - Sep 2013
Externally publishedYes


  • Documentation
  • Documentation generation
  • Literate programming
  • R
  • Rd

ASJC Scopus subject areas

  • Software
  • Statistics and Probability
  • Statistics, Probability and Uncertainty


Dive into the research topics of 'Sustainable, extensible documentation generation using inlinedocs'. Together they form a unique fingerprint.

Cite this