Published in

University of California, Los Angeles, Journal of Statistical Software, 6(54)

DOI: 10.18637/jss.v054.i06

Links

Tools

Export citation

Search in Google Scholar

Sustainable, extensible documentation generation using inlinedocs

Journal article published in 2014 by Toby Dylan Hocking, Thomas Wutzler ORCID, Keith Ponting, Philippe Grosjean
This paper is made freely available by the publisher.
This paper is made freely available by the publisher.

Full text: Download

Question mark in circle
Preprint: policy unknown
Question mark in circle
Postprint: policy unknown
Question mark in circle
Published version: policy unknown
Data provided by SHERPA/RoMEO

Abstract

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. ; info:eu-repo/semantics/published