Rethinking literate programming in statistics

E. F. Haghish ()
Additional contact information
E. F. Haghish: University of Freiburg

Stata Journal, 2016, vol. 16, issue 4, 938-963

Abstract: Literate programming is becoming increasingly trendy for data analysis because it allows the generation of dynamic-analysis reports for communicating data analysis and eliminates untraceable human errors in analysis reports. Traditionally, literate programming includes separate processes for compiling the code and preparing the documentation. While this workflow might be satisfactory for software documentation, it is not ideal for writing statistical analysis reports. Instead, these processes should run in parallel. In this article, I introduce the weaver package, which examines this idea by creating a new log system in HTML or LATEX that can be used simultaneously with the Stata log system. The new log system provides many features that the Stata log system lacks; for example, it can render mathematical notations, insert figures, create publication-ready dynamic tables, and style text, and it includes a built-in syntax highlighter. The weaver package also produces dynamic PDF documents by converting the HTML log to PDF or by typesetting the LATEX log and thus provides a real-time preview of the document without recompiling the code. I also discuss potential applications of the weaver package. Copyright 2016 by StataCorp LP.

Keywords: weave; div; img; txt; tbl; weaver; weaving; literate programming; dynamic documents; reproducible research; log; HTML; LATEX (search for similar items in EconPapers)
Date: 2016
Note: to access software from within Stata, net describe http://www.stata-journal.com/software/sj16-4/pr0063/
References: Add references at CitEc
Citations: View citations in EconPapers (3)

Downloads: (external link)
http://www.stata-journal.com/article.html?article=pr0063 link to article purchase

Related works:
This item may be available elsewhere in EconPapers: Search for items with the same title.

Export reference: BibTeX RIS (EndNote, ProCite, RefMan) HTML/Text

Persistent link: https://EconPapers.repec.org/RePEc:tsj:stataj:v:16:y:2016:i:4:p:938-963

Ordering information: This journal article can be ordered from
http://www.stata-journal.com/subscription.html

Access Statistics for this article

Stata Journal is currently edited by Nicholas J. Cox and Stephen P. Jenkins

More articles in Stata Journal from StataCorp LLC
Bibliographic data for series maintained by Christopher F. Baum () and Lisa Gilmore ().