nbstata: a new Stata kernel

A Jupyter kernel for Stata built on pystata

 

nbstata is a Jupyter kernel for Stata built on top of pystata.

For the User Guide, click here.

 

What is Jupyter?

A Jupyter notebook allows you to combine interactive code and results with Markdown in a single document. Though it is named after the three core programming languages it supports (Julia, Python, and R), it can be used with with a wide variety of languages.

nbstata allows you to create Stata notebooks (as opposed to using Stata within a Python notebook, which is needlessly clunky if you are working primarily with Stata).

Key nbstata features

• Easy setup
• Works with Stata 17+ (only).
• Displays Stata output without the redundant ‘echo’ of (multi-line) commands
• Autocompletion for variables, macros, matrices, and file paths
• DataGrid widget with browse-like capabilities (e.g., interactive filtering)
• Variable and data properties available in a ‘contextual help’ side panel
• Interactive/richtext help files accessible within notebook
• #delimit ; interactive support (along with all types of comments)
• Quarto inline code support

The video below demonstrates using Stata in a Jupyter notebook. In addition to the NBClassic application shown there, nbstata can also be used with JupyterLab, VS Code, or Quarto.

What can you do with Stata notebooks…

…that you can’t do with the official Stata interface?

• Exploratory analysis that is both:
  • interactive
  • preserved for future reference/editing
• Present results in a way that interweaves:¹
  • code
  • results (including graphs)
  • rich text:
    1. lists
    2. Headings
    3. 
    4. links
    5. math: \(y_{it}=\beta_0+\varepsilon_{it}\)

---

1. Stata dynamic documents can do this part, though with a less interactive workflow. (See also: markstat, stmd, and Statamarkdown) Using nbstata with Quarto instead gives you a similar workflow, with greater flexibility of output.

Contributing

nbstata is being developed using nbdev. The /nbs directory is where edits to the source code should be made. (The python code is then exported to the /nbdev library folder.)

For more, see CONTRIBUTING.md.

Acknowledgements

Kyle Barron authored the original stata_kernel, which works for older versions of Stata. Vinci Chow created a Stata kernel that instead uses pystata, which first became available with Stata 17. nbstata was originally derived from his pystata-kernel, but much of the docs and newer features are derived from stata_kernel.