fwl_plot {fwlplot}

FWL Plot

Description

This function creates a bivariate plot of y and x after residualizing over a set of covariates w.

Usage

fwl_plot(fml, data, ggplot = FALSE, n_sample = 1000, alpha = 0.5, ...)

fwlplot(fml, data, ggplot = FALSE, n_sample = 1000, alpha = 0.5, ...)

Arguments

fml

Of the form y ~ x + covs | fes following the fixest formula syntax. The x variable you want plotted should come first.

data

A dataframe object that contains the variables in fml.

ggplot

Boolean. Default is to use base R plot but if TRUE, use ggplot.

n_sample

Numeric. Number of observations to sample for each facet.

alpha

Numeric. Alpha transparency of each individual point. If NULL, will plot all rows.

...

Additional arguments passed to fixest::feols.

Value

Either NULL if ggplot = FALSE or a ggplot object if ggplot = TRUE. In either case, plots the figure.

Examples

fwl_plot(mpg ~ hp + wt | cyl, mtcars)