aggr_es {ggfixest} | R Documentation |
Aggregates event-study treatment effects.
Description
Aggregates post- (and/or pre-) treatment effects of an
"event-study" estimation, also known as a dynamic difference-in-differences
(DDiD) model. The event-study should have been estimated using the fixest
package, which provides a specialised i()
operator for this class
of models. By default, the function will return the average post-treatment
effect (i.e. across multiple periods). However, it can also return the
cumulative post-treatment effect and can be used to aggregate pre-treatment
effects too. At its heart, aggr_es()
is a convenience wrapper around
marginaleffects::hypotheses()
, which is used to perform the underlying
joint hypothesis test.
Usage
aggr_es(
object,
rhs = 0,
period = "post",
aggregation = c("mean", "cumulative"),
abbr_term = TRUE,
...
)
Arguments
object |
A model object of class |
rhs |
Numeric. The null hypothesis value. Defaults to 0. |
period |
Keyword string or numeric sequence. Which group of periods are we aggregating? Can either be one of three convenience strings—i.e., "post" (the default), "prep", or "both"—or a numeric sequence that matches a subset of periods in the data (e.g. 6:8). |
aggregation |
Character string. The aggregation type. Either "mean" (the default) or "cumulative". |
abbr_term |
Logical. Should the leading "term" column of the return
data frame be abbreviated? The default is TRUE. If FALSE, then the term
column will retain the full hypothesis test string as per usual with
|
... |
Additional arguments passed to |
Value
A "tidy" data frame of aggregated (pre and/or post) treatment effects, plus inferential information about standard errors, confidence intervals, etc. Potentially useful information about the underlying hypothesis test is also provided as an attribute. See Examples.
See Also
Examples
library(ggfixest) ## Will load fixest too
est = feols(y ~ x1 + i(period, treat, 5) | id + period, base_did)
# Default hypothesis test is a null mean post-treatment effect
(post_mean = aggr_es(est))
# The underlying hypothesis is saved as an attribute
attributes(post_mean)["hypothesis"]
# Other hypothesis and aggregation options
aggr_es(est, aggregation = "cumulative") # cumulative instead of mean effects
aggr_es(est, period = "pre") # pre period instead of post
aggr_es(est, period = "both") # pre & post periods separately
aggr_es(est, period = 6:8) # specific subset of periods
aggr_es(est, rhs = -1, period = "pre") # pre period with H0 value of 1
# Etc.