Partially Linear Kernel Regression with Mixed Data Types
np.plregression.Rdnpplreg computes a partially linear kernel regression estimate
of a one (1) dimensional dependent variable on \(p+q\)-variate
explanatory data, using the model \(Y = X\beta + \Theta (Z) +
\epsilon\) given a set of estimation
points, training points (consisting of explanatory data and dependent
data), and a bandwidth specification, which can be a rbandwidth
object, or a bandwidth vector, bandwidth type and kernel type.
Usage
npplreg(bws,
...)
# S3 method for class 'formula'
npplreg(bws,
data = NULL,
newdata = NULL,
y.eval = FALSE,
...)
# Default S3 method
npplreg(bws,
txdat,
tydat,
tzdat,
nomad = FALSE,
...)
# S3 method for class 'plbandwidth'
npplreg(bws,
txdat = stop("training data txdat missing"),
tydat = stop("training data tydat missing"),
tzdat = stop("training data tzdat missing"),
exdat,
eydat,
ezdat,
residuals = FALSE,
...)Arguments
Data, Bandwidth Inputs And Formula Interface
These arguments identify the bandwidth specification, formula/data interface, and partially linear training data.
- bws
a bandwidth specification. This can be set as a
plbandwidthobject returned from an invocation ofnpplregbw, or as a matrix of bandwidths, where each row is a set of bandwidths for \(Z\), with a column for each variable \(Z_i\). In the first row are the bandwidths for the regression of \(Y\) on \(Z\), the following rows contain the bandwidths for the regressions of the columns of \(X\) on \(Z\). If specified as a matrix additional arguments will need to be supplied as necessary to specify the bandwidth type, kernel types, training data, and so on.- data
an optional data frame, list or environment (or object coercible to a data frame by
as.data.frame) containing the variables in the model. If not found in data, the variables are taken fromenvironment(bws), typically the environment from whichnpplregbwwas called.- txdat
a \(p\)-variate data frame of explanatory data (training data), corresponding to \(X\) in the model equation, whose linear relationship with the dependent data \(Y\) is posited. Defaults to the training data used to compute the bandwidth object.
- tydat
a one (1) dimensional numeric or integer vector of dependent data, each element \(i\) corresponding to each observation (row) \(i\) of
txdat. Defaults to the training data used to compute the bandwidth object.- tzdat
a \(q\)-variate data frame of explanatory data (training data), corresponding to \(Z\) in the model equation, whose relationship to the dependent variable is unspecified (nonparametric). Defaults to the training data used to compute the bandwidth object.
Local-Polynomial Degree And Bandwidth Search
This argument controls the recommended automatic local-polynomial NOMAD route, which jointly selects continuous polynomial degree and bandwidths when these are computed inside npplreg.
- nomad
logical shortcut passed through to
npplregbwwhen bandwidths are computed insidenpplreg. WhenTRUE, the partially linear bandwidth route fills any missing values amongregtype,search.engine,degree.select,bernstein.basis,degree.min,degree.max,degree.verify, andbwtypewith the recommended automatic local-polynomial degree-and-bandwidth NOMAD preset documented innpplregbw. The preset selects local-polynomial degrees and bandwidths separately for the nuisance regressions \(E[Y \mid Z]\) and \(E[X_j \mid Z]\) before the final partially linear solve. Additional NOMAD tuning arguments such asnomad.nmultimay also be supplied through...;nmultiremains the outer restart count whilenomad.nmulticontrols inner native crs NOMAD API multistarts within each outer restart. After fitting, inspectfit$bws$nomad.shortcuton the returned objectfitto see the normalized shortcut metadata.
Evaluation Data And Returned Quantities
These arguments control where the partially linear regression is evaluated and which fitted quantities are returned.
- exdat
a \(p\)-variate data frame of points on which the regression will be estimated (evaluation data). By default, evaluation takes place on the data provided by
txdat.- eydat
a one (1) dimensional numeric or integer vector of the true values of the dependent variable. Optional, and used only to calculate the true errors. By default, evaluation takes place on the data provided by
tydat.- ezdat
a \(q\)-variate data frame of points on which the regression will be estimated (evaluation data). By default, evaluation takes place on the data provided by
tzdat.- newdata
An optional data frame in which to look for evaluation data. If omitted, the training data are used.
- residuals
a logical value indicating that you want residuals computed and returned in the resulting
plregressionobject. Defaults toFALSE.- y.eval
If
newdatacontains dependent data andy.eval = TRUE,npwill compute goodness of fit statistics on these data and return them. Defaults toFALSE.
Additional Arguments
Further arguments are passed to npplregbw and its component npregbw searches when bandwidths are computed internally.
- ...
additional arguments supplied to
npplregbwwhennpplregcomputes bandwidths internally, or arguments needed to interpret a numeric or matrixbwsspecification. This is where bandwidth selection controls such asbwmethod,bwtype, andbwscaling, kernel/support controls such asckertype,ckerorder, andckerbound, categorical kernel controls such asukertypeandokertype, search controls such asnmultiandscale.factor.search.lower, and local-polynomial/NOMAD controls such asregtype,degree,bernstein.basis,degree.select, andnomad.nmultiare supplied. Seenpplregbwandnpregbwfor the complete bandwidth-selection argument surface, including the child-indexed matrix/listdegreeform for fixed local-polynomial partially linear fits.
Details
Documentation guide: see npplregbw for partially linear
bandwidth selection, npregbw for the component
nonparametric regression search controls, np.kernels
for kernels, np.options for global options, and
plot, plot.np for plotting options.
When bws is omitted, the formula and default methods call
npplregbw first and pass bandwidth-selection arguments
from ... to that call. When bws is already a
plbandwidth object, npplreg estimates with the stored
bandwidth metadata in that object.
Argument groups for bandwidth selection are documented on
npplregbw and, for the component nonparametric
regressions, npregbw. The most common workflow is to
choose the linear X variables and nonparametric Z
variables first, then bandwidth/search controls for the
Z-side nonparametric regressions, and finally
local-polynomial/NOMAD controls when using polynomial-adaptive fits.
For S3 plotting help, see plot.np. You can list
available plot methods with methods("plot").
npplreg uses a combination of OLS and nonparametric
regression to estimate the parameter \(\beta\) in the model
\(Y = X\beta + \Theta (Z) + \epsilon\).
npplreg implements a variety of methods for
nonparametric regression on multivariate (\(q\)-variate) explanatory
data defined over a set of possibly continuous and/or discrete
(unordered, ordered) data. The approach is based on Li and Racine
(2003) who employ ‘generalized product kernels’ that admit a mix
of continuous and discrete data types.
Three classes of kernel estimators for the continuous data types are available: fixed, adaptive nearest-neighbor, and generalized nearest-neighbor. Adaptive nearest-neighbor bandwidths change with each sample realization in the set, \(x_i\), when estimating the density at the point \(x\). Generalized nearest-neighbor bandwidths change with the point at which the density is estimated, \(x\). Fixed bandwidths are constant over the support of \(x\).
Data contained in the data frame tzdat may be a mix of
continuous (default), unordered discrete (to be specified in the data
frame tzdat using factor), and ordered discrete
(to be specified in the data frame tzdat using
ordered). Data can be entered in an arbitrary order and
data types will be detected automatically by the routine (see
np for details).
A variety of kernels may be specified by the user. Kernels implemented for continuous data types include the second, fourth, sixth, and eighth order Gaussian and Epanechnikov kernels, and the uniform kernel. Unordered discrete data types use a variation on Aitchison and Aitken's (1976) kernel, while ordered data types use a variation of the Wang and van Ryzin (1981) kernel.
For practitioners who want the recommended automatic local-polynomial degree-and-bandwidth NOMAD route
without spelling out all LP tuning arguments,
npplreg(..., nomad=TRUE) and npplregbw(..., nomad=TRUE)
expand missing settings to the same documented preset. Explicit
incompatible settings fail fast rather than being silently rewritten.
Value
npplreg returns a plregression object. The generic
accessor functions coef, fitted,
residuals, predict, and
vcov, extract (or
estimate) coefficients, estimated values, residuals,
predictions, and variance-covariance matrices,
respectively, from
the returned object. Furthermore, the functions summary
and plot support objects of this type. The returned object
has the following components:
For plregression objects, predict(object, se.fit = TRUE)
returns a list with components fit and se.fit. The
se.fit component contains asymptotic prediction standard errors
computed from the partially linear fitted-value linear operator and
the squared residuals from the training fit.
- evalx
evaluation points
- evalz
evaluation points
- mean
estimation of the regression, or conditional mean, at the evaluation points
- xcoef
coefficient(s) corresponding to the components \(\beta_i\) in the model
- xcoeferr
standard errors of the coefficients
- xcoefvcov
covariance matrix of the coefficients
- bws
the canonical bandwidth object, stored as a
plbandwidthobject- bw
backward-compatible alias for
bws- resid
if
residuals = TRUE, in-sample or out-of-sample residuals where appropriate (or possible)- R2
coefficient of determination (Doksum and Samarov (1995))
- MSE
mean squared error
- MAE
mean absolute error
- MAPE
mean absolute percentage error
- CORR
absolute value of Pearson's correlation coefficient
- SIGN
fraction of observations where fitted and observed values agree in sign
Book And Method Pointers
The partially linear model is \(Y=X\beta+\Theta(Z)+\epsilon\). The Robinson-style construction residualizes \(Y\) and each column of \(X\) on \(Z\), then solves the final least-squares problem using those residualized variables. Thus the nonparametric part of the problem is a sequence of conditional-mean regressions \(E[Y\mid Z]\) and \(E[X_j\mid Z]\), followed by the parametric solve for \(\beta\). In local-polynomial/NOMAD fits, the nuisance regressions may select child-specific continuous polynomial degrees.
For book-length derivations, see Li and Racine (2007), Chapter 7 Semiparametric Partially Linear Models, especially Sections 7.1, 7.2, and 7.4, and Racine (2019), Chapter 8 Semiparametric Conditional Mean Function Estimation, especially Robinson's partially linear model.
References
Aitchison, J. and C.G.G. Aitken (1976), “Multivariate binary discrimination by the kernel method,” Biometrika, 63, 413-420.
Doksum, K. and A. Samarov (1995), “Nonparametric estimation of global functionals and a measure of the explanatory power of covariates in regression,” The Annals of Statistics, 23 1443-1473.
Gao, Q. and L. Liu and J.S. Racine (2015), “A partially linear kernel estimator for categorical data,” Econometric Reviews, 34 (6-10), 958-977.
Li, Q. and J.S. Racine (2007), Nonparametric Econometrics: Theory and Practice, Princeton University Press.
Li, Q. and J.S. Racine (2004), “Cross-validated local linear nonparametric regression,” Statistica Sinica, 14, 485-512.
Pagan, A. and A. Ullah (1999), Nonparametric Econometrics, Cambridge University Press.
Racine, J.S. and Q. Li (2004), “Nonparametric estimation of regression functions with both categorical and continuous data,” Journal of Econometrics, 119, 99-130.
Robinson, P.M. (1988), “Root-n-consistent semiparametric regression,” Econometrica, 56, 931-954.
Wang, M.C. and J. van Ryzin (1981), “A class of smooth estimators for discrete distributions,” Biometrika, 68, 301-309.
Author
Tristen Hayfield tristen.hayfield@gmail.com, Jeffrey S. Racine racinej@mcmaster.ca
Usage Issues
If you are using data of mixed types, then it is advisable to use the
data.frame function to construct your input data and not
cbind, since cbind will typically not work as
intended on mixed data types and will coerce the data to the same
type.
Examples
if (FALSE) { # \dontrun{
# EXAMPLE 1 (INTERFACE=FORMULA): For this example, we simulate an
# example for a partially linear model and compare the coefficient
# estimates from the partially linear model with those from a correctly
# specified parametric model...
set.seed(42)
n <- 250
x1 <- rnorm(n)
x2 <- rbinom(n, 1, .5)
z1 <- rbinom(n, 1, .5)
z2 <- rnorm(n)
y <- 1 + x1 + x2 + z1 + sin(z2) + rnorm(n)
# First, compute data-driven bandwidths. This may take a few minutes
# depending on the speed of your computer...
bw <- npplregbw(formula=y~x1+factor(x2)|factor(z1)+z2)
# Next, compute the partially linear fit
pl <- npplreg(bws=bw)
# Print a summary of the model...
summary(pl)
# Sleep for 5 seconds so that we can examine the output...
if (interactive()) Sys.sleep(5)
# Retrieve the coefficient estimates and their standard errors...
coef(pl)
coef(pl, errors = TRUE)
# Compare the partially linear results to those from a correctly
# specified model's coefficients for x1 and x2
ols <- lm(y~x1+factor(x2)+factor(z1)+I(sin(z2)))
# The intercept is coef()[1], and those for x1 and x2 are coef()[2] and
# coef()[3]. The standard errors are the square root of the diagonal of
# the variance-covariance matrix (elements 2 and 3)
coef(ols)[2:3]
sqrt(diag(vcov(ols)))[2:3]
# Sleep for 5 seconds so that we can examine the output...
if (interactive()) Sys.sleep(5)
# Plot the regression surfaces via plot() (i.e., plot the `partial
# regression surface plots').
if (interactive()) plot(bw)
# Note - to plot regression surfaces with variability bounds constructed
# from bootstrapped standard errors, use the following (note that this
# may take a minute or two depending on the speed of your computer as
# the bootstrapping is done in real time, and note also that we override
# the default number of bootstrap replications (399) reducing them to 25
# in order to quickly compute standard errors in this instance - don't
# of course do this in general)
plot(bw,
B=25,
errors="bootstrap")
# EXAMPLE 1 (INTERFACE=DATA FRAME): For this example, we simulate an
# example for a partially linear model and compare the coefficient
# estimates from the partially linear model with those from a correctly
# specified parametric model...
set.seed(42)
n <- 250
x1 <- rnorm(n)
x2 <- rbinom(n, 1, .5)
z1 <- rbinom(n, 1, .5)
z2 <- rnorm(n)
y <- 1 + x1 + x2 + z1 + sin(z2) + rnorm(n)
X <- data.frame(x1, factor(x2))
Z <- data.frame(factor(z1), z2)
# First, compute data-driven bandwidths. This may take a few minutes
# depending on the speed of your computer...
bw <- npplregbw(xdat=X, zdat=Z, ydat=y)
# Next, compute the partially linear fit
pl <- npplreg(bws=bw)
# Print a summary of the model...
summary(pl)
# Sleep for 5 seconds so that we can examine the output...
if (interactive()) Sys.sleep(5)
# Retrieve the coefficient estimates and their standard errors...
coef(pl)
coef(pl, errors = TRUE)
# Compare the partially linear results to those from a correctly
# specified model's coefficients for x1 and x2
ols <- lm(y~x1+factor(x2)+factor(z1)+I(sin(z2)))
# The intercept is coef()[1], and those for x1 and x2 are coef()[2] and
# coef()[3]. The standard errors are the square root of the diagonal of
# the variance-covariance matrix (elements 2 and 3)
coef(ols)[2:3]
sqrt(diag(vcov(ols)))[2:3]
# Sleep for 5 seconds so that we can examine the output...
if (interactive()) Sys.sleep(5)
# Plot the regression surfaces via plot() (i.e., plot the `partial
# regression surface plots').
if (interactive()) plot(bw)
# Note - to plot regression surfaces with variability bounds constructed
# from bootstrapped standard errors, use the following (note that this
# may take a minute or two depending on the speed of your computer as
# the bootstrapping is done in real time, and note also that we override
# the default number of bootstrap replications (399) reducing them to 25
# in order to quickly compute standard errors in this instance - don't
# of course do this in general)
plot(bw,
B=25,
errors="bootstrap")
} # }