MARKSTAT: Stata module to support literate data analysis using Stata and Markdown

German Rodriguez ()
Additional contact information
German Rodriguez: Princeton University

Statistical Software Components from Boston College Department of Economics

Abstract: The markstat command can be used to combine Stata code and results with comments and annotations written in Markdown, producing by default a web page. If a LaTeX installation is available, -markstat- can produce a PDF file from exactly the same input script. The command works by separating the code from the narrative, running the code through Stata, translating the narrative from Markdown to HTML or LaTeX using Pandoc, and then weaving the output files together. This avoids tedious cutting and pasting, and promotes reproducible research. The command puts a high premium on the simplicity of the input file, which emphasizes readability much in the spirit of Markdown itself. It supports Stata and Mata inline code, strict code blocks with an option to hide the commands, and mathematical equations. It can also handle citations, resolving them using a BiBTeX database and listing them at the end of the document. The command is described in a forthcoming Stata Journal article, and is supported by a website at http://data.princeton.edu/stata/markdown, which includes installation instructions, documentation, examples, and a comparison with the new tools in Stata 15.

Language: Stata
Requires: Stata version 14, whereis from SSC, pandoc
Keywords: markdown; data analysis (search for similar items in EconPapers)
Date: 2017-09-16, Revised 2021-06-03
Note: This module should be installed from within Stata by typing "ssc install markstat". The module is made available under terms of the GPL v3 (https://www.gnu.org/licenses/gpl-3.0.txt). Windows users should not attempt to download these files with a web browser.
References: Add references at CitEc
Citations:

Downloads: (external link)
http://fmwww.bc.edu/repec/bocode/m/markstat.ado program code (text/plain)
http://fmwww.bc.edu/repec/bocode/m/markstat.css style sheet (text/plain)
http://fmwww.bc.edu/repec/bocode/m/markstat.sthlp help file (text/plain)
http://fmwww.bc.edu/repec/bocode/m/markstat.docx sample file (text/plain)
http://fmwww.bc.edu/repec/bocode/m/markstats5.zip zip file of package (application/zip)

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:boc:bocode:s458401

Ordering information: This software item can be ordered from
http://repec.org/docs/ssc.php

Access Statistics for this software item

More software in Statistical Software Components from Boston College Department of Economics Boston College, 140 Commonwealth Avenue, Chestnut Hill MA 02467 USA. Contact information at EDIRC.
Bibliographic data for series maintained by Christopher F Baum ().