summary.matched.set: Summarize information about a 'matched.set' object and the...

View source: R/matched_set_obj.R

summary.matched.setR Documentation

Summarize information about a matched.set object and the matched sets contained within them.

Description

A method for viewing summary data about the sizes of matched sets and metadata about how they were created. This method accepts all standard summary arguments.

Usage

## S3 method for class 'matched.set'
summary(object, ..., verbose = TRUE)

Arguments

object

a matched.set object

...

Optional additional arguments to be passed to the summary function

verbose

Logical value specifying whether or not a longer, more verbose summary should be calculated and returned. Default is TRUE.

Value

list object with either 5 or 1 element(s), depending on whether or not verbose is set to TRUE or not.

overview

A data.frame object containing information about the treated units (unit id, time of treatment), and the number of matched control units with weights zero and above.

set.size.summary

a summary object summarizing the minimum, maximum, and IQR of matched set sizes

number.of.treated.units

The number of unit, time pairs that are considered to be "treated" units

num.units.empty.set

The number of units treated at a particular time that were not able to be matched to any control units

lag

The size of the lag window used for matching on treatment history. This affects which treated and control units are matched.

Examples

PM.results <- PanelMatch(lag = 4, time.id = "year", unit.id = "wbcode2",
                         treatment = "dem", refinement.method = "mahalanobis",
                         data = dem, match.missing = TRUE,
                         covs.formula = ~ I(lag(tradewb, 1:4)) + I(lag(y, 1:4)),
                         size.match = 5, qoi = "att",
                         outcome.var = "y", lead = 0:4, forbid.treatment.reversal = FALSE)
summary(PM.results$att)




PanelMatch documentation built on June 27, 2022, 1:06 a.m.