Published by the Foundation for Open Access Statistics Editors-in-chief: Bettina Grün, Torsten Hothorn, Rebecca Killick, Edzer Pebesma, Achim Zeileis    ISSN 1548-7660; CODEN JSSOBK
Authors: Toby Dylan Hocking, Thomas Wutzler, Keith Ponting, Philippe Grosjean
Title: Sustainable, Extensible Documentation Generation Using inlinedocs
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.

Page views:: 2201. Submitted: 2011-05-16. Published: 2013-09-08.
Paper: Sustainable, Extensible Documentation Generation Using inlinedocs     Download PDF (Downloads: 1690)
inlinedocs_2013.9.3.tar.gz: R source package Download (Downloads: 296; 73KB)
v54i06.R: R example code from the paper Download (Downloads: 340; 167B) Further replication materials Download (Downloads: 273; 5KB)

DOI: 10.18637/jss.v054.i06

This work is licensed under the licenses
Paper: Creative Commons Attribution 3.0 Unported License
Code: GNU General Public License (at least one of version 2 or version 3) or a GPL-compatible license.