Markdoc: Literate Programming in Stata. (December 2016)

• Record Type: Journal Article
• Authors: Haghish, E. F.
• Is Part Of: Stata journal. Volume 16:Number 4(2016)
• Page Start: 964
• Page End: 988
• Publication Date: 2016-12
• Subjects: pr0064 -- markdoc -- Markdown -- HTML -- LATEX -- literate programming -- dynamic documents -- reproducible research -- log file -- translator; Statistics -- Periodicals; Statistics -- Computer programs -- Periodicals; 001.422
• DOI: 10.1177/1536867X1601600409
• Languages: English
• ISSNs: 1536-867X

Abstract

Rigorous documentation of the analysis plan, procedure, and computer codes enhances the comprehensibility and transparency of data analysis. Documentation is particularly critical when the codes and data are meant to be publicly shared and examined by the scientific community to evaluate the analysis or adapt the results. The popular approach for documenting computer codes is known as literate programming, which requires preparing a trilingual script file that includes a programming language for running the data analysis, a human language for documentation, and a markup language for typesetting the document. In this article, I introducemarkdoc, a software package for interactive literate programming and generating dynamic-analysis documents in Stata.markdoc recognizes Mark-down, L A TE X, and HTML markup languages and can export documents in several formats, such as PDF, Microsoft Office.docx, OpenOffice and LibreOffice.odt, L A TE X, HTML, ePub, and Markdown.