This formula estimates an instrumental variables regression using two-stage least squares with a variety of options for robust standard errors

```
iv_robust(
formula,
data,
weights,
subset,
clusters,
fixed_effects,
se_type = NULL,
ci = TRUE,
alpha = 0.05,
diagnostics = FALSE,
return_vcov = TRUE,
try_cholesky = FALSE
)
```

formula

an object of class formula of the regression and the instruments.
For example, the formula `y ~ x1 + x2 | z1 + z2`

specifies `x1`

and `x2`

as endogenous regressors and `z1`

and `z2`

as their respective instruments.

data

A `data.frame`

weights

the bare (unquoted) names of the weights variable in the supplied data.

subset

An optional bare (unquoted) expression specifying a subset of observations to be used.

clusters

An optional bare (unquoted) name of the variable that corresponds to the clusters in the data.

fixed_effects

An optional right-sided formula containing the fixed
effects that will be projected out of the data, such as `~ blockID`

. Do not
pass multiple-fixed effects with intersecting groups. Speed gains are greatest for
variables with large numbers of groups and when using "HC1" or "stata" standard errors.
See 'Details'.

se_type

The sort of standard error sought. If `clusters`

is
not specified the options are "HC0", "HC1" (or "stata", the equivalent),
"HC2" (default), "HC3", or
"classical". If `clusters`

is specified the options are "CR0", "CR2" (default), or "stata". Can also specify "none", which may speed up estimation of the coefficients.

ci

logical. Whether to compute and return p-values and confidence intervals, TRUE by default.

alpha

The significance level, 0.05 by default.

diagnostics

logical. Whether to compute and return instrumental variable diagnostic statistics and tests.

return_vcov

logical. Whether to return the variance-covariance matrix for later usage, TRUE by default.

try_cholesky

logical. Whether to try using a Cholesky decomposition to solve least squares instead of a QR decomposition, FALSE by default. Using a Cholesky decomposition may result in speed gains, but should only be used if users are sure their model is full-rank (i.e., there is no perfect multi-collinearity)

An object of class `"iv_robust"`

.

The post-estimation commands functions `summary`

and `tidy`

return results in a `data.frame`

. To get useful data out of the return,
you can use these data frames, you can use the resulting list directly, or
you can use the generic accessor functions `coef`

, `vcov`

,
`confint`

, and `predict`

.

An object of class `"iv_robust"`

is a list containing at least the
following components:

the estimated coefficients

the estimated standard errors

the t-statistic

the estimated degrees of freedom

the p-values from a two-sided t-test using `coefficients`

, `std.error`

, and `df`

the lower bound of the `1 - alpha`

percent confidence interval

the upper bound of the `1 - alpha`

percent confidence interval

a character vector of coefficient names

the significance level specified by the user

the standard error type specified by the user

the residual variance

the number of observations used

the number of columns in the design matrix (includes linearly dependent columns!)

the rank of the fitted model

the fitted variance covariance matrix

the \(R^2\) of the second stage regression

the \(R^2\) of the second stage regression, but penalized for having more parameters, `rank`

a vector with the value of the second stage F-statistic with the numerator and denominator degrees of freedom

a vector with the value of the first stage F-statistic with the numerator and denominator degrees of freedom, useful for a test for weak instruments

whether or not weights were applied

the original function call

the matrix of predicted means

We also return various diagnostics when `diagnostics` == TRUE. These are stored in diagnostic_first_stage_fstatistic, diagnostic_endogeneity_test, and diagnostic_overid_test. They have the test statistic, relevant degrees of freedom, and p.value in a named vector. See 'Details' for more. These are printed in a formatted table when the model object is passed to summary().

This function performs two-stage least squares estimation to fit
instrumental variables regression. The syntax is similar to that in
`ivreg`

from the `AER`

package. Regressors and instruments
should be specified in a two-part formula, such as
`y ~ x1 + x2 | z1 + z2 + z3`

, where `x1`

and `x2`

are
regressors and `z1`

, `z2`

, and `z3`

are instruments. Unlike
`ivreg`

, you must explicitly specify all exogenous regressors on
both sides of the bar.

The default variance estimators are the same as in `lm_robust`

.
Without clusters, we default to `HC2`

standard errors, and with clusters
we default to `CR2`

standard errors. 2SLS variance estimates are
computed using the same estimators as in `lm_robust`

, however the
design matrix used are the second-stage regressors, which includes the estimated
endogenous regressors, and the residuals used are the difference
between the outcome and a fit produced by the second-stage coefficients and the
first-stage (endogenous) regressors. More notes on this can be found at
the mathematical appendix.

If `fixed_effects`

are specified, both the outcome, regressors, and instruments
are centered using the method of alternating projections (Halperin 1962; Gaure 2013). Specifying
fixed effects in this way will result in large speed gains with standard error
estimators that do not need to invert the matrix of fixed effects. This means using
"classical", "HC0", "HC1", "CR0", or "stata" standard errors will be faster than other
standard error estimators. Be wary when specifying fixed effects that may result
in perfect fits for some observations or if there are intersecting groups across
multiple fixed effect variables (e.g. if you specify both "year" and "country" fixed effects
with an unbalanced panel where one year you only have data for one country).

If `diagnostics`

are requested, we compute and return three sets of diagnostics.
First, we return tests for weak instruments using first-stage F-statistics (`diagnostic_first_stage_fstatistic`

). Specifically,
the F-statistics reported compare the model regressing each endogeneous variable on both the
included exogenous variables and the instruments to a model where each endogenous variable is
regressed only on the included exogenous variables (without the instruments). A significant F-test
for weak instruments provides evidence against the null hypothesis that the instruments are weak.
Second, we return tests for the endogeneity of the endogenous variables, often called the Wu-Hausman
test (`diagnostic_endogeneity_test`

). We implement the regression test from Hausman (1978), which allows for robust variance estimation.
A significant endogeneity test provides evidence against the null that all the variables are exogenous.
Third, we return a test for the correlation between the instruments and the error term (`diagnostic_overid_test`

). We implement
the Wooldridge (1995) robust score test, which is identical to Sargan's (1958) test with classical
standard errors. This test is only reported if the model is overidentified (i.e. the number of
instruments is greater than the number of endogenous regressors), and if no weights are specified.

Gaure, Simon. 2013. "OLS with multiple high dimensional category variables." Computational Statistics & Data Analysis 66: 8-1. https://doi.org/10.1016/j.csda.2013.03.024

Halperin, I. 1962. "The product of projection operators." Acta Scientiarum Mathematicarum (Szeged) 23(1-2): 96-99.

```
# NOT RUN {
library(fabricatr)
dat <- fabricate(
N = 40,
Y = rpois(N, lambda = 4),
Z = rbinom(N, 1, prob = 0.4),
D = Z * rbinom(N, 1, prob = 0.8),
X = rnorm(N),
G = sample(letters[1:4], N, replace = TRUE)
)
# Instrument for treatment `D` with encouragement `Z`
tidy(iv_robust(Y ~ D + X | Z + X, data = dat))
# Instrument with Stata's `ivregress 2sls , small rob` HC1 variance
tidy(iv_robust(Y ~ D | Z, data = dat, se_type = "stata"))
# With clusters, we use CR2 errors by default
dat$cl <- rep(letters[1:5], length.out = nrow(dat))
tidy(iv_robust(Y ~ D | Z, data = dat, clusters = cl))
# Again, easy to replicate Stata (again with `small` correction in Stata)
tidy(iv_robust(Y ~ D | Z, data = dat, clusters = cl, se_type = "stata"))
# We can also specify fixed effects, that will be taken as exogenous regressors
# Speed gains with fixed effects are greatests with "stata" or "HC1" std.errors
tidy(iv_robust(Y ~ D | Z, data = dat, fixed_effects = ~ G, se_type = "HC1"))
# }
```

Run the code above in your browser using DataCamp Workspace