English
 
User Manual Privacy Policy Disclaimer Contact us
  Advanced SearchBrowse

Item

ITEM ACTIONSEXPORT

Released

Journal Article

Sustainable, extensible documentation generation using inlinedocs

MPS-Authors
/persons/resource/persons62608

Wutzler,  Thomas
Department Biogeochemical Integration, Dr. M. Reichstein, Max Planck Institute for Biogeochemistry, Max Planck Society;

Locator
Fulltext (public)

BGC1925.pdf
(Publisher version), 315KB

Supplementary Material (public)
There is no public supplementary material available
Citation

Hocking, T. D., Wutzler, T., Ponting, K., & Grosjean, P. (2013). Sustainable, extensible documentation generation using inlinedocs. Journal of statistical software, 54(6), 1-20. doi:10.18637/jss.v054.i06.


Cite as: http://hdl.handle.net/11858/00-001M-0000-0014-5E70-4
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.