Sustainable, extensible documentation generation using inlinedocs

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.