add/improve module level docstrings

Author: drbenvincent

causalpy/exp_inverse_propensity_weighting.py

@@ -11,6 +11,10 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Inverse propensity weighting
+"""
+
 import arviz as az
 import matplotlib.pyplot as plt
 import numpy as np

causalpy/experiments.py

@@ -11,6 +11,9 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Base class for quasi experimental designs.
+"""
 
 
 class ExperimentalDesign:

causalpy/expt_diff_in_diff.py

@@ -11,6 +11,9 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Difference in differences
+"""
 
 import numpy as np
 import pandas as pd

causalpy/expt_instrumental_variable.py

@@ -11,6 +11,10 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Instrumental variable regression
+"""
+
 import numpy as np
 import pandas as pd
 from patsy import dmatrices

causalpy/expt_prepostfit.py

@@ -11,6 +11,10 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Pre/post intervention fit experiment designs
+"""
+
 from typing import Union
 
 import numpy as np

causalpy/expt_prepostnegd.py

@@ -11,6 +11,9 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Pretest/posttest nonequivalent group design
+"""
 
 import numpy as np
 import pandas as pd

causalpy/expt_regression_discontinuity.py

@@ -11,6 +11,9 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+"""
+Regression discontinuity design
+"""
 
 import warnings  # noqa: I001
 

causalpy/expt_regression_kink.py

@@ -11,6 +11,11 @@
 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
+
+"""
+Regression kink design
+"""
+
 import warnings  # noqa: I001
 
 import numpy as np

docs/source/_static/interrogate_badge.svg

@@ -12,9 +12,10 @@
   skl_models
   experiments
   expt_diff_in_diff
-  expt_instrumental_variable
-  expt_prepostfit
   expt_prepostnegd
+  expt_prepostfit
   expt_regression_discontinuity
   expt_regresion_kink
+  expt_instrumental_variable
+  expt_inverse_propensity_weighting
 ```