Skip to content
This repository was archived by the owner on Mar 11, 2022. It is now read-only.

Commit d7d1c14

Browse files
committed
Update README.md
1 parent 1fdce87 commit d7d1c14

File tree

1 file changed

+39
-24
lines changed

1 file changed

+39
-24
lines changed

README.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,68 +11,83 @@ across multiple treatment groups over multiple time periods.
1111
It is a component of [DiffinDiffs.jl](https://github.com/JuliaDiffinDiffs/DiffinDiffs.jl)
1212
that can also be used as a standalone package.
1313

14+
> **Note:**
15+
>
16+
> The development of this package is still in an early stage.
17+
> Not all features are production-ready.
18+
1419
## Applicable Environment
1520

1621
The baseline DID setup this package focuses on
17-
is the same as the one considered by [Sun and Abraham (2020)](#SunA20):
22+
is the same as the one considered by [Sun and Abraham (2020)](https://doi.org/10.1016/j.jeconom.2020.09.006):
1823

1924
* The treatment state is binary, irreversible and sharp.
2025
* Units are treated in *different* periods (possibly never treated) in a staggered fashion.
21-
* Treatment effects may evolve over time following possibly different paths across groups.
26+
* Treatment effects may evolve over time following possibly different paths across treated groups.
2227

2328
The parameters of interest include:
2429

2530
* A collection of average treatment effects
2631
on each group of treated units in different periods.
2732
* Interpretable aggregations of these group-time-level parameters.
2833

29-
## Purposes and Functionality
34+
## Motivation and Features
3035

31-
Although it is possible to accomplish the estimation goals
32-
by directly working with the regression functionality in any statistical software,
33-
the amount of work involved can be nontrivial.
36+
Although most estimation tasks covered by this package
37+
can be conducted with existing statistical software,
38+
the amount of programming work involved can be nontrivial.
3439
Ad hoc implementation for a specific study
3540
may be prone to programming errors,
3641
not reusable for future projects and also computationally inefficient.
37-
A package that fills in the gap
38-
between data preparation and estimation procedures is therefore desirable.
42+
Some extra amount of automation in conducting the estimation procedures
43+
is therefore desirable.
44+
This is especially important when the estimation involves many regressors
45+
and the dataset is relatively large.
3946

40-
Some main functionality provided by this package includes:
47+
This package aims to raise the productivity of empirical researchers
48+
with the following features:
4149

42-
* Memory-efficient generation of indicator variables needed for estimation based on data coverage.
50+
* Automatic and efficient generation of indicator variables based on empirical design and data coverage.
4351
* Enforcement of an overlap condition based on the parallel trends assumption.
4452
* Fast residualization of regressors from fixed effects via [FixedEffects.jl](https://github.com/FixedEffects/FixedEffects.jl).
45-
* Interaction-weighted DID estimators as proposed by [Sun and Abraham (2020)](#SunA20).
46-
* Cell-level weight calculations for decomposing estimates from regression.
53+
* Interaction-weighted DID estimators proposed by [Sun and Abraham (2020)](https://doi.org/10.1016/j.jeconom.2020.09.006).
54+
* Cell-level weight calculations for decomposing coefficient estimates from regression.
4755

4856
As a component of [DiffinDiffs.jl](https://github.com/JuliaDiffinDiffs/DiffinDiffs.jl),
4957
it follows the same programming interface shared by all component packages.
50-
In particular, it is benefited from the `@specset` macro
51-
that largely simplifies the construction of groups of related specifications
52-
and avoids unnecessary repetitions of the same intermediate steps
53-
(e.g., partialling out fixed effects).
54-
Tools for easing the export of estimation results are also available.
58+
In particular, it is benefited from the macros `@did` and `@specset`
59+
that largely simplify the construction of groups of related specifications
60+
and reduce unnecessary repetitions of identical intermediate steps
61+
(e.g., partialling out fixed effects for the same regressors).
62+
Tools for easing the export of estimation results are also being developed.
5563

5664
## Econometric Foundations
5765

5866
The package does not enforce the use of a specific estimation procedure
59-
and allows flexible usage from the users.
60-
However, it is designed to ease the adoption of
67+
and allows flexibility from the users.
68+
However, it is mainly designed to ease the adoption of
6169
recent advances in econometric research
6270
that overcome pitfalls in earlier empirical work.
6371

64-
The most relevant econometric studies that provide theoretical guidance
65-
are the following:
72+
The development of this package is directly based on the following studies:
73+
* [Sun and Abraham (2020)](https://doi.org/10.1016/j.jeconom.2020.09.006)
74+
* Unpublished work by the package author
75+
76+
Some other studies are also relevant and have provided inspiration:
6677

67-
* [Sun and Abraham (2020)](#SunA20)
68-
* [Goodman-Bacon (2020)](#Goodman20)
78+
* [de Chaisemartin and D'Haultfœuille (2020)](https://doi.org/10.1257/aer.20181169)
6979
* [Borusyak and Jaravel (2018)](#BorusyakJ18)
70-
* Unpublished work by the package author
80+
* [Goodman-Bacon (2020)](#Goodman20)
81+
* [Callaway and Sant'Anna (2020)](https://doi.org/10.1016/j.jeconom.2020.12.001)
7182

7283
## References
7384

7485
<a name="BorusyakJ18">**Borusyak, Kirill, and Xavier Jaravel.** 2018. "Revisiting Event Study Designs with an Application to the Estimation of the Marginal Propensity to Consume." Unpublished.</a>
7586

87+
<a name="CallawayS20">**Callaway, Brantly, and Pedro H. C. Sant'Anna.** 2020. "Difference-in-Differences with Multiple Time Periods." *Journal of Econometrics*, forthcoming.</a>
88+
89+
<a name="ChaisemartD20T">**de Chaisemartin, Clément, and Xavier D'Haultfœuille.** 2020. "Two-Way Fixed Effects Estimators with Heterogeneous Treatment Effects." *American Economic Review* 110 (9): 2964-96.</a>
90+
7691
<a name="Goodman20">**Goodman-Bacon, Andrew.** 2020. "Difference-in-Differences with Variation in Treatment Timing." Unpublished.</a>
7792

7893
<a name="SunA20">**Sun, Liyang, and Sarah Abraham.** 2020. "Estimating Dynamic Treatment Effects in Event Studies with Heterogeneous Treatment Effects." *Journal of Econometrics*, forthcoming.</a>

0 commit comments

Comments
 (0)