markdoc: Literate programming in Stata

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

Stata Journal, 2016, vol. 16, issue 4, 964-988

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 introduce markdoc, a software package for interactive literate programming and generating dynamic-analysis documents in Stata. markdoc recognizes Markdown, LATEX, and HTML markup languages and can export documents in several formats, such as PDF, Microsoft Office .docx, OpenOffice and LibreOffice .odt, LATEX, HTML, ePub, and Markdown. Copyright 2016 by StataCorp LP.

Keywords: markdoc; Markdown; HTML; LATEX; literate programming; dynamic documents; reproducible research; log file; translator (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/pr0064/
References: Add references at CitEc
Citations: View citations in EconPapers (7)

Downloads: (external link)
http://www.stata-journal.com/article.html?article=pr0064 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:964-988

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 ().