IDEAS home Printed from https://ideas.repec.org/c/boc/bocode/s458401.html
 

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

Author

Listed:
  • German Rodriguez

    (Princeton University)

Programming Language

Stata

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.

Suggested Citation

  • German Rodriguez, 2017. "MARKSTAT: Stata module to support literate data analysis using Stata and Markdown," Statistical Software Components S458401, Boston College Department of Economics, revised 03 Jun 2021.
    • Handle: RePEc:boc:bocode:s458401
    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.
    as

    Download full text from publisher

    File URL: http://fmwww.bc.edu/repec/bocode/m/markstat.ado
    File Function: program code
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/m/markstat.css
    File Function: style sheet
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/m/markstat.sthlp
    File Function: help file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/m/markstat.docx
    File Function: sample file
    Download Restriction: no
    File URL: http://fmwww.bc.edu/repec/bocode/m/markstats5.zip
    File Function: zip file of package
    Download Restriction: no
    ---><---

    More about this item

    Keywords

    markdown; data analysis; Stata;
    All these keywords.

    Statistics

    Access and download statistics

    Corrections

    All material on this site has been provided by the respective publishers and authors. You can help correct errors and omissions. When requesting a correction, please mention this item's handle: RePEc:boc:bocode:s458401. See general information about how to correct material in RePEc.

    If you have authored this item and are not yet registered with RePEc, we encourage you to do it here. This allows to link your profile to this item. It also allows you to accept potential citations to this item that we are uncertain about.

    We have no bibliographic references for this item. You can help adding them by using this form .

    If you know of missing items citing this one, you can help us creating those links by adding the relevant references in the same way as above, for each refering item. If you are a registered author of this item, you may also want to check the "citations" tab in your RePEc Author Service profile, as there may be some citations waiting for confirmation.

    For technical questions regarding this item, or to correct its authors, title, abstract, bibliographic or download information, contact: Christopher F Baum (email available below). General contact details of provider: https://edirc.repec.org/data/debocus.html .

    Please note that corrections may take a couple of weeks to filter through the various RePEc services.

    IDEAS is a RePEc service. RePEc uses bibliographic data supplied by the respective publishers.