fwlplot (version 0.2.0)

fwl_plot: 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 = NULL, ...)
fwlplot(fml, data, ggplot = FALSE, n_sample = NULL, ...)

Value

Either NULL if ggplot = FALSE or a ggplot object if ggplot = TRUE.

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. If NULL, will plot all rows.

...

Additional arguments passed to fixest::feols.

Examples

# \donttest{
fwl_plot(mpg ~ hp + wt | cyl, mtcars)
# }