Skip to content

Commit 8b4c1c6

Browse files
committed
#55 fix typo + add brief explanations of quasi experiments in index.rst
1 parent 4d3d5ba commit 8b4c1c6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/index.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
CausalPy - causal inference for quasi-experiments
77
=================================================
88

9-
A Python package focussing on causal inference for quasi-experimentas. The package allows users to use different model types. Sophisticated Bayesian methods can be used, harnessing the power of `PyMC <https://www.pymc.io/>`_ and `ArviZ <https://python.arviz.org>`_. But users can also use more traditional `Ordinary Least Squares <https://en.wikipedia.org/wiki/Ordinary_least_squares>`_ estimation methods via `scikit-learn <https://scikit-learn.org/>`_ models.
9+
A Python package focussing on causal inference for quasi-experiments. The package allows users to use different model types. Sophisticated Bayesian methods can be used, harnessing the power of `PyMC <https://www.pymc.io/>`_ and `ArviZ <https://python.arviz.org>`_. But users can also use more traditional `Ordinary Least Squares <https://en.wikipedia.org/wiki/Ordinary_least_squares>`_ estimation methods via `scikit-learn <https://scikit-learn.org/>`_ models.
1010

1111
Installation
1212
------------
@@ -35,21 +35,29 @@ Rather than focussing on one particular quasi-experimental setting, this package
3535
Synthetic control
3636
"""""""""""""""""
3737

38+
This is appropriate when you have multiple units, one of which is treated. You build a synthetic control as a weighted combination of the untreated units.
39+
3840
.. image:: ../img/synthetic_control_pymc.svg
3941

4042
Interrupted time series
4143
"""""""""""""""""""""""
4244

45+
This is appropriate when you have a single treated unit, and therefore a single time series, and do not have a set of untreated units.
46+
4347
.. image:: ../img/interrupted_time_series_pymc.svg
4448

4549
Difference in differences
4650
"""""""""""""""""""""""""
4751

52+
This is appropriate when you have a single pre and post intervention measurement and have a treament and a control group.
53+
4854
.. image:: ../img/difference_in_differences_pymc.svg
4955

5056
Regression discontinuity
5157
""""""""""""""""""""""""
5258

59+
Regression discontinuity designs are used when treatment is applied to units according to a cutoff on a running variable, which is typically not time. By looking for the presence of a discontinuity at the precise point of the treatment cutoff then we can make causal claims about the potential impact of the treatment.
60+
5361
.. image:: ../img/regression_discontinuity_pymc.svg
5462

5563
Support

0 commit comments

Comments
 (0)