Metadata-Version: 2.4
Name: propensio
Version: 1.0.6
Summary: Causal inference using Propensity Score Matching and Euclidean LCG method
Author-email: azkarohbiya <azkarohbiya@gmail.com>
License: MIT License
        
        Copyright (c) 2022 Azka Rohbiya Ramadani
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=1.3.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: matplotlib>=3.4.0
Requires-Dist: statsmodels>=0.13.0
Requires-Dist: scikit-learn>=1.0.0
Requires-Dist: plotly>=5.0.0
Requires-Dist: sortedcontainers>=2.4.0
Dynamic: license-file

# Causal Inference using PSM

# Background
Propensity score matching is a statistical technique used to estimate the effect of a treatment or intervention on an outcome of interest. It is commonly used in observational studies, where the assignment of treatment or exposure to a particular group is not randomized.

The idea behind propensity score matching is to balance the characteristics of the treatment and control groups by matching individuals with similar propensity scores, which are the probabilities of receiving the treatment or intervention based on observed covariates. This helps to control for confounding factors and reduce selection bias, allowing for a more accurate estimation of the treatment effect.

Overall, propensity score matching is a useful tool for researchers to make causal inferences in observational studies, although it is important to consider the limitations and assumptions of this method.


# Installation Guide
This function has been uploaded to [pypi](https://pypi.org/project/propensio/) so you can type on your prompt as code below
```bash
pip install propensio
```
Then import the library
```python
from propensio.matching import PropensityScoreMatch
```

If error, download [matching.py](propensio/matching.py)
then
```
from matching import *
```

# Requirements Library
This python requires related package more importantly python_requires='>=3.1', so that package can be install Make sure the other packages meet the requirements below
- pandas>=1.1.5
- numpy>=1.18.5,<2.0.0
- scipy>=1.2.0
- matplotlib>=3.1.0
- statsmodels>=0.8.0
- scikit-learn>=0.24.0

# Usage Guide
This is a Python class named PropensityScoreMatch. It is designed to perform propensity score matching, a technique used to balance the distribution of confounding variables between treatment and control groups in observational studies. The class has four input arguments:

- df: a pandas DataFrame containing the data to be analyzed.
- features: a list of column names in df that contain the variables used to calculate propensity scores.
- treatment: a string that specifies the name of the column in df that contains the treatment variable.
- outcome: a string that specifies the name of the column in df that contains the outcome variable.

The output of the class includes the following attributes:

- df_matched: a DataFrame containing the data for the matched pairs of treated and control observations.
- df_TE: a DataFrame containing the treatment effect estimates for each observation.
- df_smd: a DataFrame containing the standardized mean differences before and after matching.
- ATT: Average Treatment Effect on the Treated.
- ATE: Average Treatment Effect.
- ATC: Average Treatment Effect on the Control.

In addition, the class provides a method for visualizing the results:

- plot_smd(): generates a plot of standardized mean differences (SMDs) before vs. after matching for each feature.

# Example Usage
Importing libraries
```python
import pandas as pd
import numpy as np
import propensio

```
Initiating model
```python
# Load built-in sample data
df = propensio.load_dataset('stroke')
obj_cols = df.select_dtypes(include=['object']).columns
df = pd.get_dummies(df, columns=obj_cols).fillna(0)

df_model = df[['age', 'hypertension', 'heart_disease', 'bmi', 'stroke',
               'gender_Male', 'smoking_status_smokes', 'avg_glucose_level']]

features  = ['age', 'hypertension', 'heart_disease', 'bmi', 'gender_Male', 'avg_glucose_level']
treatment = 'smoking_status_smokes'
outcome   = 'stroke'

psm = propensio.PropensityScoreMatch(df_model, features, treatment, outcome)

```
The model will automatically print ATT, ATE, and ATC upon fitting:
```
ATT: 0.0123
ATE: 0.0118
ATC: 0.0112
```

Accessing results
```python
print(psm.ATT)        # Average Treatment Effect on the Treated
print(psm.ATE)        # Average Treatment Effect
print(psm.ATC)        # Average Treatment Effect on the Control

psm.df_matched        # Matched dataframe
psm.df_smd            # Standardized Mean Difference table
psm.df_TE             # Treatment effect dataframe
```

Evaluating SMD Plot
```python
psm.plot_smd()
```
![output1](output/df.png)

Evaluating Distribution
```python
import matplotlib.pyplot as plt
import seaborn as sns

def hist_all_features(df, features, hue):
    width = 6*len(features)
    fig, axes = plt.subplots(ncols=len(features), figsize=(width, 5))
    for i in range(len(features)):
        sns.histplot(data=df, x=features[i], ax=axes[i], hue=hue)
    plt.show()
```
```python
features_plot = ['age','hypertension','heart_disease','bmi','gender_Male','avg_glucose_level','proba']
hist_all_features(psm.df, features_plot, hue='smoking_status_smokes')
```
Output:
![output2](output/dist_1.png)

```python
hist_all_features(psm.df_matched, features_plot, hue='smoking_status_smokes')
```
![output3](output/dist_2.png)

```python
fig, axes = plt.subplots(ncols=2, figsize=(12, 5))

# Comparing Stroke Mean without Matching
stroke_by_treatment = psm.df.groupby(treatment)[[outcome]].mean()
stroke_by_treatment.plot(kind='bar', ax=axes[0], title='Before Matching')

# Comparing Stroke Mean After Matching
stroke_by_treatment = psm.df_matched.groupby(treatment)[[outcome]].mean()
stroke_by_treatment.plot(kind='bar', ax=axes[1], title='After Matching')

plt.show()
```

![output4](output/out_1.png)

# Further Analysis
---
Rather than direct comparison between matched test variant and control, you better try use Average Treatment Effect for deeper anaylysis. Here, medium article that I recommend
[ATE Causal Inference](https://medium.com/grabngoinfo/ate-vs-cate-vs-att-vs-atc-for-causal-inference-998a577f2f8c)

# Real Application

This was applied for marketing cases when dealing with above-the-line campaigns. This quite works to handle revenue dilution, more plausible incremental impact. Thanks to Rizli Anshari, Amel Dayani, Bintang who have also contributed to this development

