Rethinking Literate Programming in Statistics. (December 2016)

• Record Type: Journal Article
• Authors: Haghish, E. F.
• Is Part Of: Stata journal. Volume 16:Number 4(2016)
• Page Start: 938
• Page End: 963
• Publication Date: 2016-12
• Subjects: pr0063 -- weave -- div -- img -- txt -- tbl -- weaver -- weaving -- literate programming -- dynamic documents -- reproducible research -- log -- HTML -- LATEX; Statistics -- Periodicals; Statistics -- Computer programs -- Periodicals; 001.422
• DOI: 10.1177/1536867X1601600408
• Languages: English
• ISSNs: 1536-867X

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 theweaver package, which examines this idea by creating a new log system in HTML or L A TE X 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. Theweaver package also produces dynamic PDF documents by converting the HTML log to PDF or by typesetting the L A TE X log and thus provides a real-time preview of the document without recompiling the code. I also discuss potential applications of theweaver package.