View source: R/penhdfeppml_int.R
penhdfeppml_int  R Documentation 
penhdfeppml_int
is the internal algorithm called by penhdfeppml
to fit a penalized PPML
regression for a given type of penalty and a given value of the penalty parameter. It takes a vector
with the dependent variable, a regressor matrix and a set of fixed effects (in list form: each element
in the list should be a separate HDFE). The penalty can be either lasso or ridge, and the plugin
method can be enabled via the method
argument.
penhdfeppml_int(
y,
x,
fes,
lambda,
tol = 1e08,
hdfetol = 1e04,
glmnettol = 1e12,
penalty = "lasso",
penweights = NULL,
saveX = TRUE,
mu = NULL,
colcheck_x = FALSE,
colcheck_x_fes = TRUE,
init_z = NULL,
post = FALSE,
verbose = FALSE,
phipost = TRUE,
standardize = TRUE,
method = "placeholder",
cluster = NULL,
debug = FALSE,
gamma_val = NULL
)
y 
Dependent variable (a vector) 
x 
Regressor matrix. 
fes 
List of fixed effects. 
lambda 
Penalty parameter (a number). 
tol 
Tolerance parameter for convergence of the IRLS algorithm. 
hdfetol 
Tolerance parameter for the withintransformation step,
passed on to 
glmnettol 
Tolerance parameter to be passed on to 
penalty 
A string indicating the penalty type. Currently supported: "lasso" and "ridge". 
penweights 
Optional: a vector of coefficientspecific penalties to use in plugin lasso when

saveX 
Logical. If 
mu 
A vector of initial values for mu that can be passed to the command. 
colcheck_x 
Logical. If 
colcheck_x_fes 
Logical. If 
init_z 
Optional: initial values of the transformed dependent variable, to be used in the first iteration of the algorithm. 
post 
Logical. If 
verbose 
Logical. If 
phipost 
Logical. If 
standardize 
Logical. If 
method 
The user can set this equal to "plugin" to perform the plugin algorithm with coefficientspecific penalty weights (see details). Otherwise, a single global penalty is used. 
cluster 
Optional: a vector classifying observations into clusters (to use when calculating SEs). 
debug 
Logical. If 
gamma_val 
Numerical value that determines the regularization threshold as defined in Belloni, Chernozhukov, Hansen, and Kozbur (2016). NULL default sets parameter to 0.1/log(n). 
More formally, penhdfeppml_int
performs iteratively reweighted least squares (IRLS) on a
transformed model, as described in Breinlich, Corradi, Rocha, Ruta, Santos Silva and Zylkin (2020).
In each iteration, the function calculates the transformed dependent variable, partials out the fixed
effects (calling collapse::fhdwithin
) and then and then calls glmnet
if the selected
penalty is lasso (the default). If the user selects ridge, the analytical solution is instead
computed directly using fast C++ implementation.
For information on the plugin lasso method, see penhdfeppml_cluster_int.
If method == "lasso"
(the default), an object of class elnet
with the elements
described in glmnet, as well as:
mu
: a 1 x length(y)
matrix with the final values of the conditional mean \mu
.
deviance
.
bic
: Bayesian Information Criterion.
phi
: coefficientspecific penalty weights (only if method == "plugin"
.
x_resid
: matrix of demeaned regressors.
z_resid
: vector of demeaned (transformed) dependent variable.
If method == "ridge"
, a list with the following elements:
beta
: a 1 x ncol(x)
matrix with coefficient (beta) estimates.
mu
: a 1 x length(y)
matrix with the final values of the conditional mean \mu
.
deviance
.
bic
: Bayesian Information Criterion.
x_resid
: matrix of demeaned regressors.
z_resid
: vector of demeaned (transformed) dependent variable.
Breinlich, H., Corradi, V., Rocha, N., Ruta, M., Santos Silva, J.M.C. and T. Zylkin (2021). "Machine Learning in International Trade Research: Evaluating the Impact of Trade Agreements", Policy Research Working Paper; No. 9629. World Bank, Washington, DC.
Correia, S., P. Guimaraes and T. Zylkin (2020). "Fast Poisson estimation with high dimensional fixed effects", STATA Journal, 20, 90115.
Gaure, S (2013). "OLS with multiple high dimensional category variables", Computational Statistics & Data Analysis, 66, 818.
Friedman, J., T. Hastie, and R. Tibshirani (2010). "Regularization paths for generalized linear models via coordinate descent", Journal of Statistical Software, 33, 122.
Belloni, A., V. Chernozhukov, C. Hansen and D. Kozbur (2016). "Inference in high dimensional panel models with an application to gun control", Journal of Business & Economic Statistics, 34, 590605.
# To reduce run time, we keep only countries in the Americas:
americas < countries$iso[countries$region == "Americas"]
trade < trade[(trade$imp %in% americas) & (trade$exp %in% americas), ]
# Now generate the needed x, y and fes objects:
y < trade$export
x < data.matrix(trade[, 1:6])
fes < list(exp_time = interaction(trade$exp, trade$time),
imp_time = interaction(trade$imp, trade$time),
pair = interaction(trade$exp, trade$imp))
# Finally, we try penhdfeppml_int with a lasso penalty (the default):
reg < penhdfeppml_int(y = y, x = x, fes = fes, lambda = 0.1)
# We can also try ridge:
reg < penhdfeppml_int(y = y, x = x, fes = fes, lambda = 0.1, penalty = "ridge")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.