Estimator for the flexible partially linear IV coefficient.
Usage
ddml_fpliv(
y,
D,
Z,
X,
learners,
learners_DXZ = learners,
learners_DX = learners,
sample_folds = 10,
ensemble_type = "nnls",
shortstack = FALSE,
cv_folds = 10,
custom_ensemble_weights = NULL,
custom_ensemble_weights_DXZ = custom_ensemble_weights,
custom_ensemble_weights_DX = custom_ensemble_weights,
cluster_variable = seq_along(y),
silent = FALSE,
parallel = NULL,
fitted = NULL,
splits = NULL,
save_crossval = TRUE,
...
)Arguments
- y
The outcome variable.
- D
A matrix of endogenous variables.
- Z
A (sparse) matrix of instruments.
- X
A (sparse) matrix of control variables.
- learners
May take one of two forms, depending on whether a single learner or stacking with multiple learners is used for estimation of the conditional expectation functions. If a single learner is used,
learnersis a list with two named elements:whatThe base learner function. The function must be such that it predicts a named inputyusing a named inputX.argsOptional arguments to be passed towhat.
If stacking with multiple learners is used,
learnersis a list of lists, each containing three named elements:whatThe base learner function. The function must be such that it predicts a named inputyusing a named inputX.argsOptional arguments to be passed towhat.assign_XAn optional vector of column indices corresponding to control variables inXthat are passed to the base learner.
Omission of the
argselement results in default arguments being used inwhat. Omission ofassign_Xresults in inclusion of all variables inX.- learners_DXZ, learners_DX
Optional arguments to allow for different base learners for estimation of \(E[D \vert X, Z]\), \(E[D \vert X]\). Setup is identical to
learners.- sample_folds
Number of cross-fitting folds.
- ensemble_type
Ensemble method to combine base learners into final estimate of the conditional expectation functions. Possible values are:
"nnls"Non-negative least squares."nnls1"Non-negative least squares with the constraint that all weights sum to one."singlebest"Select base learner with minimum MSPE."ols"Ordinary least squares."average"Simple average over base learners.
Multiple ensemble types may be passed as a vector of strings.
- shortstack
Boolean to use short-stacking.
- cv_folds
Number of folds used for cross-validation in ensemble construction.
- custom_ensemble_weights
A numerical matrix with user-specified ensemble weights. Each column corresponds to a custom ensemble specification, each row corresponds to a base learner in
learners(in chronological order). Optional column names are used to name the estimation results corresponding the custom ensemble specification.- custom_ensemble_weights_DXZ, custom_ensemble_weights_DX
Optional arguments to allow for different custom ensemble weights for
learners_DXZ,learners_DX. Setup is identical tocustom_ensemble_weights. Note:custom_ensemble_weightsandcustom_ensemble_weights_DXZ,custom_ensemble_weights_DXmust have the same number of columns.- cluster_variable
A vector of cluster indices.
- silent
Boolean to silence estimation updates.
- parallel
An optional named list with parallel processing options. When
NULL(the default), computation is sequential. Supported fields:coresNumber of cores to use.
exportCharacter vector of object names to export to parallel workers (for custom learners that reference global objects).
packagesCharacter vector of additional package names to load on workers (for custom learners that use packages not imported by
ddml).
- fitted
An optional named list of per-equation cross-fitted predictions, typically obtained from a previous fit via
fit$fitted. When supplied (together withsplits), base learners are not re-fitted; only ensemble weights are recomputed. This allows fast re-estimation with a differentensemble_type. Seeddml_plmfor an example.- splits
An optional list of sample split objects, typically obtained from a previous fit via
fit$splits. Must be supplied whenfittedis provided. Can also be used standalone to provide pre-computed sample folds.- save_crossval
Logical indicating whether to store the inner cross-validation residuals used for ensemble weight computation. Default
TRUE. WhenTRUE, subsequent pass-through calls with data-driven ensembles (e.g.,"nnls") reproduce per-fold weights exactly. Set toFALSEto reduce object size at the cost of approximate weight recomputation.- ...
Additional arguments passed to internal methods.
Value
ddml_fpliv returns an object of S3 class
ddml_fpliv and ddml. See
ddml-intro for the common output structure.
Additional pass-through fields: learners,
learners_DXZ, learners_DX.
Details
Parameter of Interest: ddml_fpliv provides a Double/Debiased
Machine Learning estimator for the flexible partially linear instrumental
variable (IV) coefficient \(\theta_0\), defined by the partially linear
IV model:
$$Y = \theta_0 D + g_0(X) + \varepsilon, \quad E[\varepsilon|X, Z] = 0,$$
where \(W \equiv (Y, D, X, Z, \varepsilon)\) is a random vector such that \(E[Var(E[D|X, Z]|X)] \neq 0\), and \(g_0(X)\) is an unknown nuisance function.
Neyman Orthogonal Score: The Neyman orthogonal score is:
$$m(W; \theta, \eta) = [(Y - \ell(X)) - \theta(D - r(X))](v(X, Z) - r(X))$$
where the nuisance parameters are \(\eta = (\ell, r, v)\) taking true values \(\ell_0(X) = E[Y|X]\), \(r_0(X) = E[D|X]\), and \(v_0(X, Z) = E[D|X, Z]\).
Jacobian:
$$J = -E[(D - r(X))(v(X, Z) - r(X))^\top]$$
See ddml-intro for how the influence function
and inference are derived from these components.
See also
Other ddml estimators:
ddml-intro,
ddml_apo(),
ddml_ate(),
ddml_attgt(),
ddml_late(),
ddml_pliv(),
ddml_plm(),
ddml_policy()
Examples
# Construct variables from the included Angrist & Evans (1998) data
y = AE98[, "worked"]
D = AE98[, "morekids"]
Z = AE98[, "samesex", drop = FALSE]
X = AE98[, c("age","agefst","black","hisp","othrace","educ")]
# Estimate the partially linear IV model using a single base learner, ridge.
fpliv_fit <- ddml_fpliv(y, D, Z, X,
learners = list(what = mdl_glmnet,
args = list(alpha = 0)),
sample_folds = 2,
silent = TRUE)
summary(fpliv_fit)
#> DDML estimation: Flexible Partially Linear IV Model
#> Obs: 5000 Folds: 2
#>
#> Estimate Std. Error z value Pr(>|z|)
#> D1 -2.56e-01 1.88e-01 -1.36 0.17
#> (Intercept) -8.48e-05 6.92e-03 -0.01 0.99