Skip to content

Commit 25f187e

Browse files
committed
Update README, incl. image alt text
1 parent e82a201 commit 25f187e

File tree

3 files changed

+70
-37
lines changed

3 files changed

+70
-37
lines changed

README.md

+37-25
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
55

6+
 
7+
68
`nbstata` is a [Jupyter
79
kernel](https://docs.jupyter.org/en/latest/projects/kernels.html) for
810
[Stata](https://www.stata.com/why-use-stata/) built on top of
@@ -11,14 +13,13 @@ kernel](https://docs.jupyter.org/en/latest/projects/kernels.html) for
1113
**[*For the User Guide, click
1214
here.*](https://hugetim.github.io/nbstata/user_guide.html)**
1315

16+
 
17+
1418
## What is Jupyter?
1519

16-
[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html)
17-
is a browser-based editor that allows you to combine interactive code
18-
and results with
19-
[Markdown](https://daringfireball.net/projects/markdown/basics) in a
20-
single document (called a Jupyter notebook). It is open source and
21-
widely used. Though it is named after the three core programming
20+
A Jupyter notebook allows you to combine interactive code and results
21+
with [Markdown](https://daringfireball.net/projects/markdown/basics) in
22+
a single document. Though it is named after the three core programming
2223
languages it supports (Julia, Python, and R), it can be used with with a
2324
wide variety of languages.
2425

@@ -27,9 +28,7 @@ Stata within a *Python*
2728
notebook](https://www.stata.com/python/pystata18/notebook/Example2.html),
2829
which is needlessly clunky if you are working primarily with Stata).
2930

30-
<img align="center" width="650" src="https://github.com/kylebarron/stata_kernel/raw/master/docs/src/img/jupyter_notebook_example.gif">
31-
32-
### `nbstata` features
31+
### Key nbstata features
3332

3433
- [x] [Easy
3534
setup](https://hugetim.github.io/nbstata/user_guide.html#install)
@@ -39,11 +38,13 @@ which is needlessly clunky if you are working primarily with Stata).
3938
- [x] Autocompletion for variables, macros, matrices, and file paths
4039
- [x] DataGrid widget with `browse`-like capabilities (e.g., interactive
4140
filtering)
42-
- [x] Variable and data properties (`describe` and `e`/`return list`)
43-
available in a ‘contextual help’ side panel
41+
- [x] Variable and data properties available in a ‘contextual help’ side
42+
panel
4443
- [x] Interactive/richtext help files accessible within notebook
4544
- [x] `#delimit ;` interactive support (along with all types of
4645
comments)
46+
- [x] Quarto [inline
47+
code](https://quarto.org/docs/computations/inline-code.html) support
4748

4849
### What can you do with Stata notebooks…
4950

@@ -52,28 +53,27 @@ interface](https://www.stata.com/features/overview/graphical-user-interface/)?
5253

5354
- Exploratory analysis that is both:
5455
- interactive
55-
- preserved for future reference/editing
56-
- Present results in a way that interweaves:\[1\]
56+
- preserved for future reference/editing  
57+
- Present results in a way that interweaves:[^1]
5758
- code
5859
- results (including graphs)
5960
- rich text:
6061
1. lists
6162
2. **Headings**
62-
3. <img align="left" width="54" height="18.6" src="https://raw.githubusercontent.com/hugetim/nbstata/master/index_files/figure-commonmark/226326ec-1-image-2.png">
63+
3. <img align="left" width="54" height="18.6" src="https://raw.githubusercontent.com/hugetim/nbstata/master/index_files/figure-commonmark/226326ec-1-image-2.png" alt="WordArt of the word 'images'">
6364
4. [links](https://hugetim.github.io/nbstata/)
6465
5. math: $y_{it}=\beta_0+\varepsilon_{it}$
6566

66-
\[1\] Stata [dynamic
67-
documents](https://www.stata.com/manuals/rptdynamicdocumentsintro.pdf)
68-
can do this part, though with a less interactive workflow. (See also:
69-
[markstat](https://grodri.github.io/markstat/),
70-
[stmd](https://www.ssc.wisc.edu/~hemken/Stataworkshops/stmd/Usage/stmdusage.html),
71-
and
72-
[Statamarkdown](https://ssc.wisc.edu/~hemken/Stataworkshops/Statamarkdown/stata-and-r-markdown.html))
73-
Using `nbstata` with
74-
[Quarto](https://www.statalist.org/forums/forum/general-stata-discussion/general/1703835-ado-files-and-literate-programming)
75-
instead gives you a similar workflow, with greater flexibility of
76-
output.
67+
The video below demonstrates using Stata in a Jupyter notebook. In
68+
addition to the
69+
[NBClassic](https://nbclassic.readthedocs.io/en/stable/notebook.html)
70+
application shown there, `nbstata` can also be used with
71+
[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html),
72+
[VS
73+
Code](https://code.visualstudio.com/docs/datascience/jupyter-notebooks),
74+
or [Quarto](https://quarto.org/).
75+
76+
<img align="center" width="650" src="https://kylebarron.dev/stata_kernel/img/jupyter_notebook_example.gif" alt="Animated demo showing major Stata kernel features in a Jupyter notebook">
7777

7878
## Contributing
7979

@@ -93,3 +93,15 @@ versions of Stata. Vinci Chow created a Stata kernel that instead uses
9393
available with Stata 17. `nbstata` was originally derived from his
9494
[pystata-kernel](https://github.com/ticoneva/pystata-kernel), but much
9595
of the docs and newer features are derived from `stata_kernel`.
96+
97+
[^1]: Stata [dynamic
98+
documents](https://www.stata.com/manuals/rptdynamicdocumentsintro.pdf)
99+
can do this part, though with a less interactive workflow. (See
100+
also: [markstat](https://grodri.github.io/markstat/),
101+
[stmd](https://www.ssc.wisc.edu/~hemken/Stataworkshops/stmd/Usage/stmdusage.html),
102+
and
103+
[Statamarkdown](https://ssc.wisc.edu/~hemken/Stataworkshops/Statamarkdown/stata-and-r-markdown.html))
104+
Using `nbstata` with
105+
[Quarto](https://www.statalist.org/forums/forum/general-stata-discussion/general/1703835-ado-files-and-literate-programming)
106+
instead gives you a similar workflow, with greater flexibility of
107+
output.

nbs/custom.yml

+3
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ website:
99
right:
1010
- icon: github
1111
href: "https://github.com/hugetim/nbstata"
12+
format:
13+
html:
14+
reference-location: section

nbs/index.ipynb

+30-12
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,18 @@
1313
"cell_type": "markdown",
1414
"metadata": {},
1515
"source": [
16+
"&nbsp;\n",
17+
"\n",
1618
"`nbstata` is a [Jupyter kernel](https://docs.jupyter.org/en/latest/projects/kernels.html) for [Stata](https://www.stata.com/why-use-stata/) built on top of [pystata](https://www.stata.com/python/pystata18/index.html)."
1719
]
1820
},
1921
{
2022
"cell_type": "markdown",
2123
"metadata": {},
2224
"source": [
23-
"**[*For the User Guide, click here.*](https://hugetim.github.io/nbstata/user_guide.html)**"
25+
"**[*For the User Guide, click here.*](https://hugetim.github.io/nbstata/user_guide.html)**\n",
26+
"\n",
27+
"&nbsp;"
2428
]
2529
},
2630
{
@@ -34,27 +38,26 @@
3438
"cell_type": "markdown",
3539
"metadata": {},
3640
"source": [
37-
"[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html) is a browser-based editor that allows you to combine interactive code and results with [Markdown](https://daringfireball.net/projects/markdown/basics) in a single document (called a Jupyter notebook). It is open source and widely used. 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. \n",
41+
"A Jupyter notebook allows you to combine interactive code and results with [Markdown](https://daringfireball.net/projects/markdown/basics) 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. \n",
3842
"\n",
39-
"`nbstata` allows you to create Stata notebooks (as opposed to [using Stata within a *Python* notebook](https://www.stata.com/python/pystata18/notebook/Example2.html), which is needlessly clunky if you are working primarily with Stata).\n",
40-
"\n",
41-
"<img align=\"center\" width=\"650\" src=\"https://kylebarron.dev/stata_kernel/img/jupyter_notebook_example.gif\">"
43+
"`nbstata` allows you to create Stata notebooks (as opposed to [using Stata within a *Python* notebook](https://www.stata.com/python/pystata18/notebook/Example2.html), which is needlessly clunky if you are working primarily with Stata)."
4244
]
4345
},
4446
{
4547
"cell_type": "markdown",
4648
"metadata": {},
4749
"source": [
48-
"### `nbstata` features\n",
50+
"### Key nbstata features\n",
4951
"\n",
5052
"- [x] [Easy setup](https://hugetim.github.io/nbstata/user_guide.html#install)\n",
5153
"- [x] Works with Stata 17+ (only).\n",
5254
"- [x] Displays Stata output without the redundant 'echo' of (multi-line) commands\n",
5355
"- [x] Autocompletion for variables, macros, matrices, and file paths\n",
5456
"- [x] DataGrid widget with `browse`-like capabilities (e.g., interactive filtering)\n",
55-
"- [x] Variable and data properties (`describe` and `e`/`return list`) available in a 'contextual help' side panel\n",
57+
"- [x] Variable and data properties available in a 'contextual help' side panel\n",
5658
"- [x] Interactive/richtext help files accessible within notebook\n",
57-
"- [x] `#delimit ;` interactive support (along with all types of comments)"
59+
"- [x] `#delimit ;` interactive support (along with all types of comments)\n",
60+
"- [x] Quarto [inline code](https://quarto.org/docs/computations/inline-code.html) support"
5861
]
5962
},
6063
{
@@ -67,18 +70,33 @@
6770
"* Exploratory analysis that is both:\n",
6871
" * interactive\n",
6972
" * preserved for future reference/editing\n",
70-
" \n",
71-
"* Present results in a way that interweaves:[1]\n",
73+
"&nbsp;"
74+
]
75+
},
76+
{
77+
"cell_type": "markdown",
78+
"metadata": {},
79+
"source": [
80+
"* Present results in a way that interweaves:[^1]\n",
7281
" * code\n",
7382
" * results (including graphs)\n",
7483
" * rich text: \n",
7584
" 1. lists\n",
7685
" 2. **Headings**\n",
77-
" 3. <img align=\"left\" width=\"54\" height=\"18.6\" src=\"https://raw.githubusercontent.com/hugetim/nbstata/master/index_files/figure-commonmark/226326ec-1-image-2.png\">\n",
86+
" 3. <img align=\"left\" width=\"54\" height=\"18.6\" src=\"https://raw.githubusercontent.com/hugetim/nbstata/master/index_files/figure-commonmark/226326ec-1-image-2.png\" alt=\"WordArt of the word 'images'\">\n",
7887
" 4. [links](https://hugetim.github.io/nbstata/) \n",
7988
" 5. math: $y_{it}=\\beta_0+\\varepsilon_{it}$\n",
8089
"\n",
81-
"[1] Stata [dynamic documents](https://www.stata.com/manuals/rptdynamicdocumentsintro.pdf) can do this part, though with a less interactive workflow. (See also: [markstat](https://grodri.github.io/markstat/), [stmd](https://www.ssc.wisc.edu/~hemken/Stataworkshops/stmd/Usage/stmdusage.html), and [Statamarkdown](https://ssc.wisc.edu/~hemken/Stataworkshops/Statamarkdown/stata-and-r-markdown.html)) Using `nbstata` with [Quarto](https://www.statalist.org/forums/forum/general-stata-discussion/general/1703835-ado-files-and-literate-programming) instead gives you a similar workflow, with greater flexibility of output."
90+
"[^1]: Stata [dynamic documents](https://www.stata.com/manuals/rptdynamicdocumentsintro.pdf) can do this part, though with a less interactive workflow. (See also: [markstat](https://grodri.github.io/markstat/), [stmd](https://www.ssc.wisc.edu/~hemken/Stataworkshops/stmd/Usage/stmdusage.html), and [Statamarkdown](https://ssc.wisc.edu/~hemken/Stataworkshops/Statamarkdown/stata-and-r-markdown.html)) Using `nbstata` with [Quarto](https://www.statalist.org/forums/forum/general-stata-discussion/general/1703835-ado-files-and-literate-programming) instead gives you a similar workflow, with greater flexibility of output."
91+
]
92+
},
93+
{
94+
"cell_type": "markdown",
95+
"metadata": {},
96+
"source": [
97+
"The video below demonstrates using Stata in a Jupyter notebook. In addition to the [NBClassic](https://nbclassic.readthedocs.io/en/stable/notebook.html) application shown there, `nbstata` can also be used with [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/getting_started/overview.html), [VS Code](https://code.visualstudio.com/docs/datascience/jupyter-notebooks), or [Quarto](https://quarto.org/).\n",
98+
"\n",
99+
"<img align=\"center\" width=\"650\" src=\"https://kylebarron.dev/stata_kernel/img/jupyter_notebook_example.gif\" alt=\"Animated demo showing major Stata kernel features in a Jupyter notebook\">"
82100
]
83101
},
84102
{

0 commit comments

Comments
 (0)