Diff of /README.md [000000] .. [a29fce]

Switch to unified view

a b/README.md
1
# OutcomeWeights - Extending Treatment Effect Estimation
2
3
## Overview
4
5
This repository contains the implementation of **Task 2** for the Causal Machine Learning group assignment. The focus is on extending the functionality of the `OutcomeWeights` package to support additional treatment effect estimators, including ATT, ATU, Overlap, and LATE. The project also includes replication of balancing checks and numerical equivalence tests for the new estimators.
6
7
## Repository Structure
8
9
```
10
OutcomeWeights-Extensions/
11
12
├── README.md                # Overview of the project (this file)
13
├── LICENSE                  # License for the project
14
├── .gitignore               # Files and folders to exclude from version control
15
├── data/                    # Placeholder for datasets or details on accessing them
16
│   └── README.md            # Instructions for dataset usage
17
├── notebooks/               # R notebooks for replication and analysis
18
│   ├── Notebook_Average.Rmd
19
│   ├── Notebook_Heterogeneous.Rmd
20
│   └── README.md            # Descriptions of the notebooks
21
├── scripts/                 # R scripts for estimator implementation
22
│   ├── Task2_StartingPoint.R
23
│   └── OutcomeWeights_Extensions.R
24
├── slides/                  # Presentation slides summarizing findings
25
│   └── Task2_Pitch.pdf
26
├── docs/                    # Additional documentation and references
27
│   └── references.md        # Links to related research and materials
28
```
29
30
## Installation
31
32
1. Clone this repository using HTTPS:
33
34
   ```bash
35
   git clone https://github.com/PulkitT01/CausalML-OutcomeWeights-Extensions.git
36
   ```
37
38
2. Install required R packages:
39
40
   ```R
41
   install.packages(c("grf", "hdm", "OutcomeWeights"))
42
   ```
43
44
3. Open the R notebooks or scripts to explore and run the analysis.
45
46
## Objectives
47
48
1. Extend the `OutcomeWeights` package to implement the following treatment effect estimators:
49
   - **ATT** (Average Treatment Effect on the Treated)
50
   - **ATU** (Average Treatment Effect on the Untreated)
51
   - **Overlap** (Average Treatment Effect in the Overlap Region)
52
   - **LATE** (Local Average Treatment Effect)
53
2. Replicate balancing checks for the new estimators to validate numerical equivalence.
54
3. Document challenges faced and solutions implemented.
55
56
## Usage
57
58
- **Scripts**:
59
60
  - `Task2_StartingPoint.R`: Provides the initial script for implementing additional estimators.
61
  - `OutcomeWeights_Extensions.R`: Contains the completed implementation for ATT, ATU, Overlap, and LATE estimators.
62
63
- **Notebooks**:
64
65
  - `Notebook_Average.Rmd` and `Notebook_Heterogeneous.Rmd`: Contain replication of treatment effect estimations for numerical validation.
66
67
## Results
68
69
The results demonstrate the successful implementation and replication of:
70
71
1. **ATT (Average Treatment Effect on the Treated):**
72
   - Numerical equivalence validated.
73
2. **ATU (Average Treatment Effect on the Untreated):**
74
   - Numerical equivalence validated.
75
3. **Overlap (Average Treatment Effect in the Overlap Region):**
76
   - Numerical equivalence validated.
77
4. **LATE (Local Average Treatment Effect):**
78
   - Numerical equivalence validated.
79
80
## Challenges and Solutions
81
82
- **Reverse-engineering package functionalities:** Required detailed exploration of the `grf` and `OutcomeWeights` implementations to extend compatibility.
83
- **Adapting balancing checks:** Implemented custom residual-on-residual regression for the Overlap estimator.
84
- **Numerical equivalence:** Validated results through comparisons with package outputs and manual calculations.
85
86
## References
87
88
- [OutcomeWeights GitHub Repository](https://github.com/MCKnaus/OutcomeWeights)
89
- [Generalized Random Forests (grf)](https://github.com/grf-labs/grf)
90
- [Research Paper: "Treatment Effects as Weighted Outcomes"](https://doi.org/10.48550/arXiv.2411.11559)
91
92
## License
93
94
This project is licensed under the MIT License - see the `LICENSE` file for details.
95
96
## Contact
97
98
For questions or feedback, please contact:
99
100
- **Pulkit Thukral** (*[pulkit.thukral@student.uni-tuebingen.de](mailto:pulkit.thukral@student.uni-tuebingen.de)*)
101
- **Jiha Kim** (*[jiha.kim@student.uni-tuebingen.de](mailto:jiha.kim@student.uni-tuebingen.de)*)
102
- **Sumitrra Bala Subramaniam** (*[sumitrra.bala-subramaniam@student.uni-tuebingen.de](mailto:sumitrra.bala-subramaniam@student.uni-tuebingen.de)*)
103
- **Timothy Leske** (*[timothy.leske@student.uni-tuebingen.de](mailto:timothy.leske@student.uni-tuebingen.de)*)
104