plot.gapclosing: Plot function for gapclosing objects

In gapclosing: Estimate Gaps Under an Intervention

Description

Produces summary plots for a gapclosing object.

Usage

## S3 method for class 'gapclosing'
plot(x, return_plots = FALSE, arranged = FALSE, ...)

Arguments

x	An object of class gapclosing, which results from a call to the function gapclosing
return_plots	Logical, defaults to FALSE. If TRUE, returns a list of the 4 plots without printing. Defaults to FALSE, in which case the console will interactively ask the user to hit "return" to proceed through printouts of the four plots, with no plots returned.
arranged	Logical, defaults to FALSE. If TRUE, returns a list of the 4 plots arranged in a 2x2 table. Useful to visualize all four in one screen.
...	Other arguments to plot commands

Value

If return_plots = TRUE, returns a list of ggplot2 objects. If return_plots = FALSE (the default), then nothing is returned and output is printed.

References

Lundberg I (2021). "The gap-closing estimand: A causal approach to study interventions that close disparities across social categories." Sociological Methods and Research. Available at https://osf.io/gx4y3/.

gapclosing documentation built on Oct. 11, 2021, 9:07 a.m.