Stata Markdown

Posted on  by admin
  1. Stata Markdoc
  2. Stata Markdown R
  3. Stata Markdown Graph

News

Markdown is a simple, standardized text-formatting language that you can read about at Wikipedia. You mix Markdown with Stata commands that create the output you want. Think of the file you create as being a do-file on steroids. You then run dyndoc to produce a webpage—an HTML file. The resulting HTML file will contain formatted text along. Keywords: Stata, webdoc, HTML, Markdown, weaving, Stata output, Stata log, reproducible research Contents 1 Introduction 3 2 The webdoc command 4 2.1.

Use the Stata Jupyter kernel with Atom's Hydrogen package to show Stata results inline. It works with Windows, macOS, and Linux.

Markdown is a simple, standardized text-formatting language that you can read about at Wikipedia. You mix Markdown with Stata commands that create the output you want. Think of the file you create as being a do-file on steroids. You then run dyndoc to produce a webpage—an HTML file. The resulting HTML file will contain formatted text along. In this article, I introduce markstat, a command for combining Stata code and output with comments and annotations written in Markdown into a beautiful webpage or PDF file, thus encouraging literate programming and reproducible research.The command tangles the input separating Stata and Markdown code, runs the Stata code, relies on Pandoc to process the Markdown code, and then. Markdown is a simple, standardized text-formatting language that you can read about at Wikipedia. You mix Markdown with Stata commands that create the output you want. Think of the file you create as being a do-file on steroids. You then run dyndoc to produce a Word document (.docx).

Example uses the Atom Material Syntax theme and Fira Code font.

Features

Markdown

This package highlights:

  • System commands, functions, and function arguments
  • Macros, both global and local
    • Accurately colors nested macros and escaped macros in strings when you want the inner macro to evaluate at runtime
    • Colors macro extended functions inside `: ... ' as well as after local lname:
  • Comments, more accurately than Stata's Do-file Editor.
  • Regular expressions
    • Colors both the limited syntax provided through the regexr() and regexm() functions, as well as the vastly expanded regex syntax provided in Stata 14 and 15 through the ustrregexm(), ustrregexrf(), and ustrregexra() functions.
  • Dynamic Markdown and LaTeX documents. Instructions below.

Stata Markdoc

Markdown

Other nice features:

  • Works with unicode identifiers. Use unicode anywhere it's legal Stata syntax.
  • Autocomplete for functions with a drop-down help menu. (This can be turned off in the settings).
  • Autocomplete for commands and macros.
  • Alerts you if your variable name is illegal, i.e. if your variable name is more than 32 chars, starts with a number, or is a reserved name.
  • Alerts you if you have any text other than } on a line ending a foreach/forvalues/if/else command
  • Local macro back tick autocompletion. When you write a `, Atom automatically fills in a ' after your cursor
  • Makes it easy to spot incorrect nesting of compound quotes
  • Support for programming ligatures for all valid Stata syntax for fonts that support them, like the Fira Code font.
  • Highlights SQL queries used in the odbc command. (The language-sql base package must be active.)
  • Highlights Docblockr-style keywords inside comments (anything like @Note)

Installation

To install, do one of the following:

  • Go to Preferences/Settings > Install > Packages; and then search for language-stata
  • At the command line, type apm install language-stata

The local macro back tick autocompletion won't function until you fully restart Atom. Do ctrl-shift-P or cmd-shift-P to bring up the command palette, type Window: Reload, and click enter.

Configuration

Atom allows you to toggle whether a line is commented using ctrl+/. As of version 1.6.5, the comment character this uses is // by default. You can change this to use /* */ or * characters to comment lines.

To change to /* */ comments, you can put the following in your config.cson file.

To change to * comments, use the following. However I don't recommend using this character1.

Note that in your config.cson file there can only be a single '.source.stata' top-level key, and only a single editor key under '.source.stata'. If you customize some other settings within the Stata grammar, you might already have a '.source.stata' key, and thus you would add the commentStart key to it.

Running Code

There are three ways to run code in Stata from Atom

  1. The Hydrogen package in conjunction with the Stata Jupyter kernel shows Stata results inside Atom next to your code. The gif at the top of the page is an example of this setup. A few features:

    • Works with Windows, macOS, and Linux. Has an easier install on Windows than stata-exec.
    • Use a different session of Stata for each file, or connect them all to the same session.
    • Autocompletions as you type based on the variables and macros in memory
    • Use any type of comments in your code
    • Low-latency connections with remote sessions of Stata. Possible to reconnect to a running remote session if you get disconnected.
    • Use #delimit ; interactively with your code
    • Run code blocks within a Stata dynamic document

    You'll need to have both Hydrogen and stata_kernel installed. You caninstall Hydrogen from the Atom settings pane; see the stata_kerneldocumentation for moreinformation on how to install stata_kernel.

  2. The stata-exec package sends selected Stata code to an open Stata GUI window on Windows, macOS, and Linux. This differs from Hydrogen because it allows you to still interact with the Stata GUI. This might be easier for users who are new to Stata. However, it can be difficult to successfully install this on Windows.

  3. The script package will run code in the Stata console, but has the limitations 1) each command is run in a separate session of Stata, 2) it currently doesn't work with selections; you have to run the entire file, 3) it doesn't work on Windows.

Dynamic Documents

Stata 15 brought new features for working with dynamic documents. The dyndoc command lets you write in Markdown and converts your file and code to HTML for viewing in a web browser.

Stata markdown software

It also added the dyntext command, which fills in Stata output for any text file, without touching the text itself. This lets you then use third-party document generators like Pandoc and LaTeX to generate documents.

Syntax Highlighting

This package provides syntax highlighting for Stata code written inside Stata's dynamic tags for Markdown and LaTeX documents.

By default, this package's Markdown and LaTeX syntax highlighting will be applied for files ending in .domd and .dotex respectively. The language-markdown and language-latex packages must be installed for the highlighting to work.

If you name your file with a different extension, you can manually set the highlighting by clicking on the 'Plain Text' button on the bottom right of the screen (or by pressing CTRL+SHIFT+L). Then type stata and you'll see a list of choices:For a .do file, choose source.stata; for a Markdown dynamic document choose source.dyndoc.md.stata; and for a LaTeX dynamic document choose source.dyndoc.latex.stata.

Stata

Both Hydrogen and stata-exec should work for running code interactively, even within a dynamic document.

Examples

An example of the PDF output of using dyntext and Pandoc is in the examples folder: dyntext.pdf.

That file was created by running

from inside Stata 15, and then with

Stata Markdown R

on the command line using Pandoc.

The file dyntext.dotex is a proof-of-concept and should compile with LaTeX but the output is not shown here.

Webdoc support

If you use the user-created commandwebdoc, you canadd highlighting by using a .dowd file extension or by manually selecting thelanguage of the current file to be 'Stata Webdoc'.

Footnotes

1: The following code is legal Stata code, but Atom will confuse the * used as multiplication with the * used for a comment. So if your cursor is on the second line and you press ctrl+/, Atom will remove the * symbol and the semantic meaning of the multiplication will be lost. Thus using // as the comment symbol is safer.

10.1 Introduction

For some Stata documentation, you may want to include portions of Stata's help files.

When I present workshops on Stata programming topics, I often refer to the Help files. I use them constantly myself, and I usually want my audience to learn to do the same.

I can usually just write 'look up command name' or provide a URL. But every once in a while, I want to include something from a Help file in my own writing. Sometimes I want to make a point about how the Help itself is laid out.

10.2 Example - help graph

For example, I recently found myself wanting to discuss some of the many tasks accomplished with Stata's graph command, and it is useful to look at how Stata has grouped these in its own documentation. In Stata, type the command:

What you will see in the Help (below) is that the first group of graph commands draw graphs, that is, they specify how the ink is to go on the page (pixels on the screen), and then carry out that task.

The other graph commands, grouped further down, are utility procedures that mostly manipulate a graph that has been produced. (I have only included part of the Help page here.)

10.3 The R Markdown

There are three steps to this little display:

  • a fake call to help graph. This is faked because it is a command Stata would ignore in batch mode.
  • a hidden translate command (in Stata). This converts Stata's marked up (SMCL) help into plain text.
  • a hidden readLines command (in R). This gives us our 'output' in the document.

To see the details, see the source.

Stata Markdown Graph

(This page was written using Statamarkdown version 0.5.5.)