Merge pull request #95 from pymc-labs/start-glossary

Add a (modest) glossary page to the docs.

Author: drbenvincent

docs/conf.py

@@ -65,7 +65,13 @@
 
 # MyST options for working with markdown files.
 # Info about extensions here https://myst-parser.readthedocs.io/en/latest/syntax/optional.html?highlight=math#admonition-directives # noqa: E501
-myst_enable_extensions = ["dollarmath", "amsmath", "colon_fence", "linkify"]
+myst_enable_extensions = [
+    "dollarmath",
+    "amsmath",
+    "colon_fence",
+    "linkify",
+    "html_admonition",
+]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

docs/glossary.md

@@ -0,0 +1,17 @@
+# Glossary
+
+<div class="admonition note" name="html-admonition">
+<p class="title">Note:</p>
+Some of the definitions have been copied (or inspired by) various resources, including Reichardt (2019).
+</div>
+
+**Change score analysis:** Statistical procedure where the dependent variable is the difference between the posttest and protest scores. Another term for 'differences in differences'.
+
+**Difference in Differences:** Analysis where the treatment effect is estimated as a difference between treatment conditions in the differences between pre-treatment to post treatment observations.
+
+**Regression discontinuity design:** A quasi–experimental comparison to estimate a treatment effect where units are assigned to treatment conditions based on a cut-off score on a quantitative assignment variable (aka running variable).
+
+**Synthetic control method:** The synthetic control method is a statistical method used to evaluate the effect of an intervention in comparative case studies. It involves the construction of a weighted combination of groups used as controls, to which the treatment group is compared.
+
+## References
+* Reichardt, C. S. (2019). Quasi-experimentation: A guide to design and analysis. Guilford Publications.

docs/index.rst

@@ -98,6 +98,11 @@ This repository is supported by `PyMC Labs <https://www.pymc-labs.io>`_.
 Documentation outline
 =====================
 
+.. toctree::
+   :titlesonly:
+
+   glossary.md
+
 .. toctree::
    :caption: Examples
    :titlesonly: