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

Switch to unified view

a b/notebooks/README.md
1
# README for Notebooks
2
3
## Overview
4
This folder contains R notebooks used for replication and analysis tasks in the **OutcomeWeights - Extending Treatment Effect Estimation** project. The notebooks demonstrate the application of the OutcomeWeights package on 401(k) data and serve as a foundation for extending the package's functionality.
5
6
## Contents
7
### Notebooks
8
1. **Notebook_Average.Rmd**
9
   - Focuses on estimating the **Average Treatment Effects (ATE)** using the OutcomeWeights package.
10
   - Includes replications of average effect calculations and validation with the 401(k) dataset.
11
12
2. **Notebook_Heterogeneous.Rmd**
13
   - Examines **Heterogeneous Treatment Effects (HTE)** based on the 401(k) dataset.
14
   - Demonstrates the use of causal forests to estimate subgroup effects.
15
16
### Supporting Materials
17
- **Dataset**: The notebooks use the 401(k) dataset bundled within the OutcomeWeights package.
18
- **Outputs**: Graphs and tables generated during the replication are saved in the `outputs/figures` directory for reference.
19
20
## Installation and Setup
21
To run the notebooks:
22
1. Ensure the required R packages are installed:
23
   ```R
24
   install.packages(c("grf", "hdm", "OutcomeWeights"))
25
   ```
26
2. Open the `.Rmd` files in RStudio or any compatible R Notebook interface.
27
3. Run the code chunks sequentially to replicate the results.
28
29
## Usage
30
- **Notebook_Average.Rmd**:
31
  - Explore how to compute ATE using the OutcomeWeights package.
32
  - Validate results using the built-in functions and manual calculations.
33
34
- **Notebook_Heterogeneous.Rmd**:
35
  - Investigate heterogeneous effects using causal forests.
36
  - Analyze subgroup-level treatment effects and compare them with average effects.
37
38
## Notes
39
- Ensure a working internet connection for downloading required packages if not already installed.
40
- Use the provided `requirements.R` file in the root directory to check for dependencies.
41
42
## References
43
- [OutcomeWeights Documentation](https://github.com/MCKnaus/OutcomeWeights)
44
- [Generalized Random Forests Documentation](https://github.com/grf-labs/grf)
45
- [Research Paper: "Treatment Effects as Weighted Outcomes"](https://doi.org/10.48550/arXiv.2411.11559)
46
47
---
48
49
For further queries, please refer to the main `README.md` file.