IDEAS home Printed from https://ideas.repec.org/a/tsj/stataj/v16y2016i4p964-988.html
   My bibliography  Save this article

markdoc: Literate programming in Stata

Author

Listed:
  • E. F. Haghish

    (University of Freiburg)

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.

Suggested Citation

  • E. F. Haghish, 2016. "markdoc: Literate programming in Stata," Stata Journal, StataCorp LP, vol. 16(4), pages 964-988, December.
    • Handle: RePEc:tsj:stataj:v:16:y:2016:i:4:p:964-988
    Note: to access software from within Stata, net describe http://www.stata-journal.com/software/sj16-4/pr0064/
    as

    Download full text from publisher

    File URL: http://www.stata-journal.com/article.html?article=pr0064
    File Function: link to article purchase
    Download Restriction: no
    ---><---

    Citations

    Citations are extracted by the CitEc Project, subscribe to its RSS feed for this item.
    as


    Cited by:

    1. Valérie Orozco & Christophe Bontemps & Élise Maigné & Virginie Piguet & Annie Hofstetter & Anne Marie Lacroix & Fabrice Levert & Jean-Marc Rousselle, 2017. "How to make a pie? Reproducible Research for Empirical Economics & Econometrics," Post-Print hal-01939942, HAL.
    2. Sergio Correia & Matthew P. Seay, 2024. "require: Package dependencies for reproducible research," Stata Journal, StataCorp LP, vol. 24(4), pages 599-613, December.
    3. Valérie Orozco & Christophe Bontemps & Elise Maigné & Virginie Piguet & Annie Hofstetter & Anne Lacroix & Fabrice Levert & Jean‐Marc Rousselle, 2020. "How To Make A Pie: Reproducible Research For Empirical Economics And Econometrics," Journal of Economic Surveys, Wiley Blackwell, vol. 34(5), pages 1134-1169, December.
    4. Raymond P. Guiteras & Ahnjeong Kim & Brian Quistorff & Clayson Shumway, 2023. "statacons: An SCons-based build tool for Stata," Stata Journal, StataCorp LP, vol. 23(1), pages 148-196, March.
    5. Ben Jann, 2022. "sttex: A new dynamic document command for Stata and LaTeX," Northern European Stata Conference 2022 11, Stata Users Group.

    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:tsj:stataj:v:16:y:2016:i:4:p:964-988. 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 or Lisa Gilmore (email available below). General contact details of provider: http://www.stata-journal.com/ .

    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.