Kernel Conditional Density Bandwidth Selection with Mixed Data Types
np.condensity.bw.Rdnpcdensbw computes a conbandwidth object for
estimating the conditional density of a \(p+q\)-variate kernel
density estimator defined over mixed continuous and discrete
(unordered, ordered) data using either the normal-reference
rule-of-thumb, likelihood cross-validation, or least-squares cross
validation using the method of Hall, Racine, and Li (2004).
Usage
npcdensbw(...)
# S3 method for class 'formula'
npcdensbw(formula, data, subset, na.action, call, ...)
# S3 method for class 'conbandwidth'
npcdensbw(xdat = stop("data 'xdat' missing"),
ydat = stop("data 'ydat' missing"),
bws,
bandwidth.compute = TRUE,
cfac.dir = 2.5*(3.0-sqrt(5)),
scale.factor.init = 0.5,
dfac.dir = 0.25*(3.0-sqrt(5)),
dfac.init = 0.375,
dfc.dir = 3,
ftol = 1.490116e-07,
scale.factor.init.upper = 2.0,
hbd.dir = 1,
hbd.init = 0.9,
initc.dir = 1.0,
initd.dir = 1.0,
invalid.penalty = c("baseline","dbmax"),
itmax = 10000,
lbc.dir = 0.5,
scale.factor.init.lower = 0.1,
lbd.dir = 0.1,
lbd.init = 0.1,
memfac = 500,
nmulti,
penalty.multiplier = 10,
powell.remin = TRUE,
bwsolver = c("powell", "mads", "mads+powell"),
scale.init.categorical.sample = FALSE,
scale.factor.search.lower = NULL,
cvls.quadrature.grid = NULL,
cvls.quadrature.extend.factor = NULL,
cvls.quadrature.points = NULL,
cvls.quadrature.ratios = NULL,
small = 1.490116e-05,
tol = 1.490116e-04,
transform.bounds = FALSE,
...)
# Default S3 method
npcdensbw(xdat = stop("data 'xdat' missing"),
ydat = stop("data 'ydat' missing"),
bws,
bandwidth.compute = TRUE,
bwmethod,
bwscaling,
bwtype,
cfac.dir,
scale.factor.init,
cxkerbound,
cxkerlb,
cxkerorder,
cxkertype,
cxkerub,
cykerbound,
cykerlb,
cykerorder,
cykertype,
cykerub,
dfac.dir,
dfac.init,
dfc.dir,
ftol,
scale.factor.init.upper,
hbd.dir,
hbd.init,
initc.dir,
initd.dir,
invalid.penalty,
itmax,
lbc.dir,
scale.factor.init.lower,
lbd.dir,
lbd.init,
memfac,
nmulti,
oxkertype,
oykertype,
penalty.multiplier,
nomad.remin = FALSE,
powell.remin,
bwsolver = c("powell", "mads", "mads+powell"),
scale.init.categorical.sample,
scale.factor.search.lower = NULL,
cvls.quadrature.grid = c("hybrid", "uniform", "sample"),
cvls.quadrature.extend.factor = 1,
cvls.quadrature.points = c(100L, 50L),
cvls.quadrature.ratios = c(0.20, 0.55, 0.25),
small,
tol,
transform.bounds,
uxkertype,
uykertype,
regtype = c("lc", "ll", "lp"),
basis = c("glp", "additive", "tensor"),
degree = NULL,
degree.select = c("manual", "coordinate", "exhaustive"),
search.engine = c("nomad+powell", "cell", "nomad"),
nomad = FALSE,
nomad.nmulti = 0L,
degree.min = NULL,
degree.max = NULL,
degree.start = NULL,
degree.restarts = 0L,
degree.max.cycles = 20L,
degree.verify = FALSE,
bernstein.basis = FALSE,
...)Arguments
Data, Bandwidth Inputs And Formula Interface
These arguments identify the data, formula interface, and whether bandwidths are supplied or computed.
- bandwidth.compute
a logical value which specifies whether to do a numerical search for bandwidths or not. If set to
FALSE, aconbandwidthobject will be returned with bandwidths set to those specified inbws. Defaults toTRUE.- bws
a bandwidth specification. This can be set as a
conbandwidthobject returned from a previous invocation, or as a \(p+q\)-vector of bandwidths, with each element \(i\) up to \(i=q\) corresponding to the bandwidth for column \(i\) inydat, and each element \(i\) from \(i=q+1\) to \(i=p+q\) corresponding to the bandwidth for column \(i-q\) inxdat. In either case, the bandwidth supplied will serve as a starting point in the numerical search for optimal bandwidths. If specified as a vector, then additional arguments will need to be supplied as necessary to specify the bandwidth type, kernel types, selection methods, and so on. This can be left unset.- call
the original function call. This is passed internally by
npwhen a bandwidth search has been implied by a call to another function. It is not recommended that the user set this.- 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(formula), typically the environment from which the function is called.- formula
a symbolic description of variables on which bandwidth selection is to be performed. The details of constructing a formula are described below.
- na.action
a function which indicates what should happen when the data contain
NAs. The default is set by thena.actionsetting of options, and isna.failif that is unset. The (recommended) default isna.omit.- subset
an optional vector specifying a subset of observations to be used in the fitting process.
- xdat
a \(p\)-variate data frame of explanatory data on which bandwidth selection will be performed. The data types may be continuous, discrete (unordered and ordered factors), or some combination thereof.
- ydat
a \(q\)-variate data frame of dependent data on which bandwidth selection will be performed. The data types may be continuous, discrete (unordered and ordered factors), or some combination thereof.
Automatic Degree Search Controls
These arguments control automatic local-polynomial degree search when regtype="lp".
- degree.max
optional scalar or integer vector giving upper bounds for automatic degree search over continuous
xdatpredictors whendegree.select != "manual".- degree.max.cycles
positive integer giving the maximum number of coordinate-search sweeps over the degree vector. Ignored for
"manual"and"exhaustive"degree selection.- degree.min
optional scalar or integer vector giving lower bounds for automatic degree search over continuous
xdatpredictors whendegree.select != "manual".- degree.restarts
non-negative integer giving the number of additional deterministic coordinate-search restarts. Ignored for
"manual"and"exhaustive"degree selection.- degree.select
character string controlling local-polynomial degree handling when
regtype="lp"."manual"(default) treatsdegreeas fixed."coordinate"performs cached coordinate-wise search over admissible degree vectors for the continuousxdatpredictors."exhaustive"evaluates the full admissible degree grid whensearch.engine="cell". For NOMAD-based search engines, any non-"manual"value requests direct joint search over degree and bandwidth coordinates.- degree.start
optional starting degree vector for automatic coordinate search. If omitted, the search starts from the degree-zero local-constant baseline on the continuous
xdatpredictors.- degree.verify
logical value indicating whether a coordinate-search solution should be exhaustively verified over the admissible degree grid after the heuristic phase completes. Available only for
search.engine="cell".
Bandwidth Criterion And Representation
These arguments choose the selection criterion and the way continuous bandwidths are represented.
- bwmethod
which method to use to select bandwidths.
cv.mlspecifies likelihood cross-validation,cv.lsspecifies least-squares cross-validation, andnormal-referencejust computes the ‘rule-of-thumb’ bandwidth \(h_j\) using the standard formula \(h_j = 1.06 \sigma_j n^{-1/(2P+l)}\), where \(\sigma_j\) is an adaptive measure of spread of the \(j\)th continuous variable defined as min(standard deviation, mean absolute deviation/1.4826, interquartile range/1.349), \(n\) the number of observations, \(P\) the order of the kernel, and \(l\) the number of continuous variables. Note that when there exist factors and the normal-reference rule is used, there is zero smoothing of the factors. Defaults tocv.ml.- bwscaling
a logical value that when set to
TRUEthe supplied bandwidths are interpreted as ‘scale factors’ (\(c_j\)), otherwise when the value isFALSEthey are interpreted as ‘raw bandwidths’ (\(h_j\) for continuous data types, \(\lambda_j\) for discrete data types). For continuous data types, \(c_j\) and \(h_j\) are related by the formula \(h_j = c_j \sigma_j n^{-1/(2P+l)}\), where \(\sigma_j\) is an adaptive measure of spread of continuous variable \(j\) defined as min(standard deviation, mean absolute deviation/1.4826, interquartile range/1.349), \(n\) the number of observations, \(P\) the order of the kernel, and \(l\) the number of continuous variables. For discrete data types, \(c_j\) and \(h_j\) are related by the formula \(h_j = c_jn^{-2/(2P+l)}\), where here \(j\) denotes discrete variable \(j\). Defaults toFALSE.- bwtype
character string used for the continuous variable bandwidth type, specifying the type of bandwidth to compute and return in the
conbandwidthobject. Defaults tofixed. Option summary:fixed: compute fixed bandwidthsgeneralized_nn: compute generalized nearest neighborsadaptive_nn: compute adaptive nearest neighbors
Categorical Search Initialization
These controls set categorical search starts and categorical direction-set initialization.
- dfac.dir
stretch factor for direction set search for Powell's algorithm for categorical variables. See Details
- dfac.init
non-random initial values for scale factors for categorical variables for Powell's algorithm. See Details
- hbd.dir
upper bound for direction set search for Powell's algorithm for categorical variables. See Details
- hbd.init
upper bound for scale factors for categorical variables for Powell's algorithm. See Details
- initd.dir
initial non-random values for direction set search for Powell's algorithm for categorical variables. See Details
- lbd.dir
lower bound for direction set search for Powell's algorithm for categorical variables. See Details
- lbd.init
lower bound for scale factors for categorical variables for Powell's algorithm. See Details
- scale.init.categorical.sample
a logical value that when set to
TRUEscaleslbd.dir,hbd.dir,dfac.dir, andinitd.dirby \(n^{-2/(2P+l)}\), \(n\) the number of observations, \(P\) the order of the kernel, and \(l\) the number ofnumericvariables. See Details
Continuous Direction-Set Search Controls
These controls set Powell direction-set initialization for continuous variables.
- cfac.dir
stretch factor for direction set search for Powell's algorithm for
numericvariables. See Details- dfc.dir
chi-square degrees of freedom for direction set search for Powell's algorithm for
numericvariables. See Details- initc.dir
initial non-random values for direction set search for Powell's algorithm for
numericvariables. See Details- lbc.dir
lower bound for direction set search for Powell's algorithm for
numericvariables. See Details
Continuous Kernel Support Controls
These controls choose and parameterize bounded support for continuous kernels.
- cxkerbound
character string controlling continuous-kernel support handling for
xdat. Can be set asnone(default kernel on full support),range(use sample min/max), orfixed(usecxkerlb/cxkerub). The bounded-kernel route reuses the selected continuous kernel and renormalizes it on the chosen support; seenp.kernels.- cxkerlb
numeric scalar/vector of lower bounds for continuous
xdatvariables used whencxkerbound="fixed". Must satisfy lower-bound validity for each variable (e.g.,<= min(variable)). Use-Inffor unbounded below. Seenp.kernelsfor bounded-kernel normalization details.- cxkerub
numeric scalar/vector of upper bounds for continuous
xdatvariables used whencxkerbound="fixed". Must satisfy upper-bound validity for each variable (e.g.,>= max(variable)). UseInffor unbounded above. Seenp.kernelsfor bounded-kernel normalization details.- cykerbound
character string controlling continuous-kernel support handling for
ydat. Can be set asnone(default kernel on full support),range(use sample min/max), orfixed(usecykerlb/cykerub). The bounded-kernel route reuses the selected continuous kernel and renormalizes it on the chosen support; seenp.kernels.- cykerlb
numeric scalar/vector of lower bounds for continuous
ydatvariables used whencykerbound="fixed". Must satisfy lower-bound validity for each variable (e.g.,<= min(variable)). Use-Inffor unbounded below. Seenp.kernelsfor bounded-kernel normalization details.- cykerub
numeric scalar/vector of upper bounds for continuous
ydatvariables used whencykerbound="fixed". Must satisfy upper-bound validity for each variable (e.g.,>= max(variable)). UseInffor unbounded above. Seenp.kernelsfor bounded-kernel normalization details.
Continuous Scale-Factor Search Initialization
These controls define deterministic and random continuous scale-factor starts and the lower admissibility floor for fixed-bandwidth search.
- scale.factor.init
deterministic initial scale factor for continuous fixed-bandwidth search. Defaults to
0.5. The value supplied by the user is not rewritten, but the effective first start passed to the optimizer ismax(scale.factor.init, scale.factor.search.lower). See Details.- scale.factor.init.lower
lower endpoint for random continuous scale-factor starts. Defaults to
0.1. The value supplied by the user is not rewritten, but the effective random-start lower endpoint ismax(scale.factor.init.lower, scale.factor.search.lower). See Details.- scale.factor.init.upper
upper endpoint for random continuous scale-factor starts. Defaults to
2.0. It must be greater than or equal to the effective lower endpoint,max(scale.factor.init.lower, scale.factor.search.lower); otherwise bandwidth search errors rather than silently expanding the interval. See Details.- scale.factor.search.lower
optional nonnegative scalar giving the hard lower admissibility bound for continuous fixed-bandwidth search candidates. Defaults to
NULL. IfNULL, an existing bandwidth object's stored value is inherited when available; otherwise the package default0.1is used. This floor applies to computed/search bandwidth candidates and to effective search starts only. It does not rewrite explicit bandwidths supplied for storage withbandwidth.compute = FALSE. Final fixed-bandwidth search candidates must also have a finite valid raw objective value.
Kernel Type Controls
These controls choose continuous, unordered, and ordered kernels for xdat and ydat.
- cxkerorder
numeric value specifying kernel order for
xdat(one of(2,4,6,8)). Kernel order specified along with auniformcontinuous kernel type will be ignored. Defaults to2.- cxkertype
character string used to specify the continuous kernel type for
xdat. Can be set asgaussian,epanechnikov, oruniform. Defaults togaussian.- cykerorder
numeric value specifying kernel order for
ydat(one of(2,4,6,8)). Kernel order specified along with auniformcontinuous kernel type will be ignored. Defaults to2.- cykertype
character string used to specify the continuous kernel type for
ydat. Can be set asgaussian,epanechnikov, oruniform. Defaults togaussian.- oxkertype
character string used to specify the ordered categorical kernel type for
xdat. Can be set aswangvanryzin,liracine, orracineliyan. Defaults toliracine.- oykertype
character string used to specify the ordered categorical kernel type for
ydat. Can be set aswangvanryzin,liracine, orracineliyan. Defaults toliracine.- uxkertype
character string used to specify the unordered categorical kernel type for
xdat. Can be set asaitchisonaitkenorliracine. Defaults toaitchisonaitken.- uykertype
character string used to specify the unordered categorical kernel type for
ydat. Can be set asaitchisonaitkenorliracine. Defaults toaitchisonaitken.
Least-Squares Quadrature Controls
These controls tune quadrature for bounded continuous-response least-squares cross-validation.
- cvls.quadrature.extend.factor
a positive finite scalar controlling the finite numerical integration window used by bounded conditional-density
cv.lsquadrature when one or both continuous response-side bounds are infinite. Finite bounds are used literally. Defaults to1.- cvls.quadrature.grid
character string specifying the one-dimensional bounded
cv.ls\(I_1\) quadrature grid."uniform"uses only evenly spaced nodes over the finite quadrature window,"sample"uses deterministic ranked sample-\(y\) nodes, and"hybrid"uses a fixed-size merge controlled bycvls.quadrature.ratios. The default is"hybrid"for scalar continuous responses and"uniform"for two continuous responses.- cvls.quadrature.points
a two-element integer vector giving the bounded
cv.lsquadrature point counts for one and two continuous response variables, respectively. Defaults toc(100L, 50L). For two continuous response variables, the second entry is used per dimension.- cvls.quadrature.ratios
a three-element non-negative numeric vector summing to one, giving the uniform, ranked sample-\(y\), and composite Gauss-Legendre proportions used by the scalar bounded
cv.ls"hybrid"quadrature grid. Defaults toc(0.20, 0.55, 0.25), which gives an20/55/25split whencvls.quadrature.points = c(100L, 50L)and the nearest deterministic exact-count split at other scalar grid sizes. The setting is ignored by explicit"uniform"and"sample"grid modes.
When response-side bounds are set explicitly to fixed infinite endpoints,
bounded cv.ls uses a finite numerical quadrature surrogate over the
data range extended by cvls.quadrature.extend.factor. In that edge
case, callers who want tighter agreement with the ordinary unbounded
convolution route should set cvls.quadrature.points explicitly.
Local-Polynomial Model Specification
These arguments control the local-polynomial estimator, basis, and fixed degree specification.
- basis
character string specifying the polynomial basis used when
regtype="lp". Options are"glp","additive", and"tensor".- bernstein.basis
logical value controlling Bernstein basis evaluation for
regtype="lp". When automatic degree search is requested andbernstein.basisis not explicitly supplied, the search route defaults toTRUEfor numerical stability. Explicitbernstein.basis=FALSEis honored, but raw-polynomial search can be poorly conditioned at higher degrees.- degree
integer scalar or integer vector of polynomial degrees for continuous
xdatvariables whenregtype="lp". If scalar, the value is recycled to all continuousxdatvariables. With no continuousxdatpredictors,regtype="lp"is only admissible whendegree=0, the local-constant equivalent.- regtype
character string specifying the conditional local method used for the
xdatregression weight operator. Options are"lc","ll", and"lp". Fornpc*methods,"ll"is implemented via the canonical local polynomial engine withdegree = 1andbasis = "glp"."ll"and positive-degree"lp"require at least one continuousxdatpredictor; for categorical-onlyxdat, use"lc"or"lp"withdegree=0. If local-linearcv.lssearch fails while using this canonical raw basis, retrying explicitly withregtype="lp",degree=1, andbernstein.basis=TRUE, or centering/scaling the continuous regressors, can improve numerical conditioning without changing package defaults or invoking an automatic fallback.
NOMAD Search Controls
These arguments control the optional NOMAD direct-search route for local-polynomial degree and bandwidth search.
- nomad
logical or character shortcut for the recommended automatic local-polynomial NOMAD route. When
TRUE, any missing values amongregtype,search.engine,degree.select,bernstein.basis,degree.min,degree.max,degree.verify, andbwtypeare filled withregtype="lp",search.engine="nomad+powell",degree.select="coordinate",bernstein.basis=TRUE,degree.min=0L,degree.max=10L,degree.verify=FALSE, andbwtype="fixed". Explicit incompatible settings error immediately; in particular, explicitnomad=TRUEcurrently requiresregtype="lp",bwtype="fixed", automatic degree search, no explicitdegree, at least one continuousxdatpredictor, andsearch.engine %in% c("nomad", "nomad+powell"). This shortcut does not change the meaning ofnmultiornomad.nmulti:nmultiremains the outer restart count, whilenomad.nmulticontrols inner native crs NOMAD API multistarts within each outer restart. Returned bandwidth objects retain this normalized preset metadata inbw$nomad.shortcutfor a returned objectbw; when available,nomad.timeandpowell.timerecord the direct-search and Powell-polish timing components.- nomad.nmulti
non-negative integer controlling the inner the native crs NOMAD C API multistart count used within each outer NOMAD restart when
regtype="lp"and automatic degree search usessearch.engine="nomad"or"nomad+powell". Defaults to0L, which preserves the current one-start-per- restart behavior. This does not replacenmulti:nmulticontrols outer restarts, whilenomad.nmulticontrols inner NOMAD multistarts within each outer restart. Advanced native NOMAD parameters may be supplied asnomad.optsthrough...; invalid or unsupported parameters are rejected by NOMAD rather than silently ignored. Routes that evaluate R callbacks require serial callback evaluation and reject parallel callback settings such asNB_THREADS_PARALLEL_EVAL > 1.- nomad.remin
logical flag controlling the optional second NOMAD hot start. When
TRUE, NOMAD is restarted once from the best full candidate found, including both bandwidth and degree coordinates. Defaults toFALSE; current simulation evidence favors the one-pass NOMAD default for routine use, while leaving this switch available for sensitivity checks.- search.engine
character string controlling the automatic local-polynomial search backend when
regtype="lp"anddegree.select != "manual"."nomad+powell"(default) performs direct joint search over thexdat-side continuous bandwidth coordinates and degree vector using the native crs NOMAD C API, then applies one Powell hot start from the NOMAD solution."nomad"omits the Powell refinement."cell"profiles the criterion over the admissible degree grid using repeated fixed-degree bandwidth solves. NOMAD-based search supportsbwtype="fixed",bwtype="generalized_nn", andbwtype="adaptive_nn"; it currently requiresdegree.verify=FALSEand the suggested package crs to be installed.
Numerical Search And Tolerance Controls
These controls set optimizer tolerances, restart behavior, invalid-candidate penalties, memory blocking, and bounded search transformations.
- ftol
fractional tolerance on the value of the cross-validation function evaluated at located minima (of order the machine precision or perhaps slightly larger so as not to be diddled by roundoff). Defaults to
1.490116e-07(1.0e+01*sqrt(.Machine$double.eps)).- invalid.penalty
a character string specifying the penalty used when the optimizer encounters invalid bandwidths.
"baseline"returns a finite penalty based on a baseline objective;"dbmax"returnsDBL\_MAX. Defaults to"baseline".- itmax
integer number of iterations before failure in the numerical optimization routine. Defaults to
10000.- memfac
The algorithm to compute the least-squares objective function uses a block-based algorithm to eliminate or minimize redundant kernel evaluations. Due to memory, hardware and software constraints, a maximum block size must be imposed by the algorithm. This block size is roughly equal to memfac*10^5 elements. Empirical tests on modern hardware find that a memfac of 500 performs well. If you experience out of memory errors, or strange behaviour for large data sets (>100k elements) setting memfac to a lower value may fix the problem.
- nmulti
integer number of times to restart the process of finding extrema of the cross-validation function from different (random) initial points
- penalty.multiplier
a numeric multiplier applied to the baseline penalty when
invalid.penalty="baseline". Defaults to10.- powell.remin
logical flag controlling Powell restart-from-minimum behavior. For ordinary fixed-degree Powell-style search,
TRUErestarts the local search from the located minimum. Forsearch.engine="nomad+powell", this controls only the final Powell bandwidth-polish step. The default isTRUEfor ordinary Powell routes andFALSEfor the Powell polish after NOMAD unless explicitly supplied.- bwsolver
bandwidth optimizer for fixed-degree searches. The default
"powell"preserves the historical Powell route."mads"uses the native crs NOMAD C API over the bandwidth coordinates, and"mads+powell"applies one Powell hot start from the MADS solution. Usesearch.enginerather thanbwsolverfor automatic degree search. Advanced native NOMAD parameters may be supplied asnomad.optsthrough...; invalid or unsupported parameters are rejected by NOMAD rather than silently ignored.- small
a small number used to bracket a minimum (it is hopeless to ask for a bracketing interval of width less than sqrt(epsilon) times its central value, a fractional width of only about 10-04 (single precision) or 3x10-8 (double precision)). Defaults to
small = 1.490116e-05 (1.0e+03*sqrt(.Machine$double.eps)).- tol
tolerance on the position of located minima of the cross-validation function (tol should generally be no smaller than the square root of your machine's floating point precision). Defaults to
1.490116e-04 (1.0e+04*sqrt(.Machine$double.eps)).- transform.bounds
a logical value that when set to
TRUEapplies an internal transformation that maps the unconstrained search to the feasible bandwidth domain. Defaults toFALSE.
Details
The scale.factor.* controls are dimensionless search
controls. The package converts scale factors to bandwidths using the
estimator-specific scaling encoded in the bandwidth object, including
kernel order and the number of continuous variables relevant for the
estimator. Users should not pre-multiply these controls by sample-size
or standard-deviation factors.
scale.factor.init controls the deterministic first search
start. scale.factor.init.lower and
scale.factor.init.upper define the random multistart interval.
scale.factor.search.lower is the lower admissibility bound for
continuous fixed-bandwidth search candidates. The effective first
start is max(scale.factor.init, scale.factor.search.lower),
and the effective random-start lower endpoint is
max(scale.factor.init.lower, scale.factor.search.lower).
scale.factor.init.upper must be at least that effective lower
endpoint; the package errors rather than silently expanding the user's
interval.
When scale.factor.search.lower is NULL, an existing
bandwidth object's stored floor is inherited when available;
otherwise the package default 0.1 is used. Explicit bandwidths
supplied for storage with bandwidth.compute = FALSE are not
rewritten by the search floor.
Categorical search-start controls such as dfac.init,
lbd.init, and hbd.init have separate semantics and are
not affected by scale.factor.search.lower.
For bwmethod="cv.ml", the ordinary contribution is based on
\(\log(\hat f_i)\). Compact-support kernels can yield
zero leave-one-out conditional-density estimates, and local-polynomial
or higher-order-kernel fits can yield negative estimates. In those
cases the package optimizes a guarded CVML criterion rather than the
literal log likelihood. Let \(\epsilon\) denote the
positive machine floor used for the guard. Positive fitted values use
the ordinary branch \(-\log(\hat f_i)\). Near-zero
fitted values use \(-\log(\epsilon)\), and negative
fitted values use the smooth penalty
\(\log(-\hat f_i)-2\log(\epsilon)\).
The guarded count reported in bandwidth summaries records
objective evaluations in which this guard was used. The
bwmethod="cv.ls" criterion remains well defined for negative
kernel density estimates and is not modified by this CVML guard.
Documentation guide: see np.kernels for kernels, np.options for global options, and plot, plot.np for plotting options.
The bandwidth-selection argument surface is easiest to read by
decision group. Start with the data and bandwidth inputs
(xdat, ydat, bws, and
bandwidth.compute), then choose the bandwidth criterion and
representation (bwmethod, bwscaling, and
bwtype). Next choose continuous kernel and support controls
(cxker* and cyker*), categorical kernel controls
(uxkertype, uykertype, oxkertype, and
oykertype), and numerical search controls including
nmulti, tolerances, penalties, and the scale.factor.*
search-start and admissibility controls. Bounded continuous-response
cv.ls fits may also use the cvls.quadrature.*
controls. Local-polynomial and NOMAD controls
(regtype, basis, degree*,
search.engine, nomad, nomad.nmulti, and
bernstein.basis) are relevant when using the explicit
local-polynomial route.
For S3 plotting help, see plot.np. You can list
available plot methods with methods("plot").
npcdensbw implements a variety of methods for choosing
bandwidths for multivariate distributions (\(p+q\)-variate) defined
over a set of possibly continuous and/or discrete (unordered, ordered)
data. The approach is based on Li and Racine (2004) who employ
‘generalized product kernels’ that admit a mix of continuous
and discrete data types.
The cross-validation methods employ multivariate numerical search
algorithms. For fixed local-constant/local-linear fits, and for
local-polynomial fits with degree.select="manual", bandwidth
search uses multidimensional Powell direction-set optimization.
Bandwidths can (and will) differ for each variable which is, of course, desirable.
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\).
npcdensbw may be invoked either with a formula-like
symbolic
description of variables on which bandwidth selection is to be
performed or through a simpler interface whereby data is passed
directly to the function via the xdat and ydat
parameters. Use of these two interfaces is mutually exclusive.
Data contained in the data frames xdat and ydat may be a
mix of continuous (default), unordered discrete (to be specified in
the data frames using factor), and ordered discrete (to be
specified in the data frames using ordered). Data can be
entered in an arbitrary order and data types will be detected
automatically by the routine (see np for details).
Data for which bandwidths are to be estimated may be specified
symbolically. A typical description has the form dependent data
~ explanatory data,
where dependent data and explanatory data are both
series of variables specified by name, separated by
the separation character '+'. For example, y1 + y2 ~ x1 + x2
specifies that the bandwidths for the joint distribution of variables
y1 and y2 conditioned on x1 and x2 are to
be estimated. See below for further examples.
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.
When regtype="lp" and degree.select != "manual",
npcdensbw can jointly determine the xdat-side local
polynomial degree vector and the fixed bandwidth coordinates entering
the conditional density criterion. With
search.engine="cell", the criterion is profiled over the
admissible degree grid using cached coordinate-wise or exhaustive
search. With search.engine="nomad" or
"nomad+powell", the criterion is optimized directly over the
joint degree/bandwidth space using the native crs NOMAD C API;
"nomad+powell" then performs one Powell hot start from the
NOMAD solution and keeps the better of the direct NOMAD and polished
answers. This polynomial-adaptive joint-search route is motivated by
Hall and Racine (2015) together with Li, Li, and Racine (under
revision). When bernstein.basis is not explicitly supplied,
the automatic search route defaults to bernstein.basis=TRUE
for numerical stability.
Setting nomad=TRUE is a convenience preset for this automatic
LP route, not a generic optimizer alias. For conditional density
bandwidth selection it expands any missing values to the equivalent
long-form call
npcdensbw(...,
regtype = "lp",
search.engine = "nomad+powell",
degree.select = "coordinate",
bernstein.basis = TRUE,
degree.min = 0L,
degree.max = 10L,
degree.verify = FALSE,
bwtype = "fixed")
Compatible explicit tuning arguments are respected. Incompatible
explicit settings fail fast so the shortcut never silently changes
user-selected semantics.
The character value nomad="auto" applies the same LP
shortcut but leaves search.engine and degree.select
eligible for data-driven resolution when both were not supplied
explicitly: scalar continuous degree searches use the exhaustive
degree-grid route, while higher-dimensional degree searches keep the
NOMAD/Powell route. Explicit search.engine or
degree.select choices are honored.
The optimizer invoked for search is Powell's conjugate direction
method which requires the setting of (non-random) initial values and
search directions for bandwidths, and, when restarting, random values
for successive invocations. Bandwidths for numeric variables
are scaled by robust measures of spread, the sample size, and the
number of numeric variables where appropriate. Two sets of
parameters for bandwidths for numeric can be modified, those
for initial values for the parameters themselves, and those for the
directions taken (Powell's algorithm does not involve explicit
computation of the function's gradient). The default values are set by
considering search performance for a variety of difficult test cases
and simulated cases. We highly recommend restarting search a large
number of times to avoid the presence of local minima (achieved by
modifying nmulti). Further refinement for difficult cases can
be achieved by modifying these sets of parameters. However, these
parameters are intended more for the authors of the package to enable
‘tuning’ for various methods rather than for the user themselves.
Value
npcdensbw returns a conbandwidth object, with the
following components:
- xbw
bandwidth(s), scale factor(s) or nearest neighbours for the explanatory data,
xdat- ybw
bandwidth(s), scale factor(s) or nearest neighbours for the dependent data,
ydat- fval
objective function value at minimum
if bwtype is set to fixed, an object containing
bandwidths (or scale factors if bwscaling = TRUE) is
returned. If it is set to generalized_nn or adaptive_nn,
then instead the \(k\)th nearest neighbors are returned for the
continuous variables while the discrete kernel bandwidths are returned
for the discrete variables.
The functions predict, summary and plot support
objects of type conbandwidth.
Book And Method Pointers
npcdensbw selects response and conditioning bandwidths, and
when requested local-polynomial degree/search metadata, for the
conditional density target \(f(y\mid x)\) estimated by
npcdens.
For book-length derivations, see Li and Racine (2007), Chapter 5 Conditional Density Estimation, especially Sections 5.1-5.4, and Chapter 4 Kernel Estimation with Mixed Data. The later workflow treatment is Racine (2019), Chapter 4 Conditional Probability Density and Cumulative Distribution Functions.
References
Aitchison, J. and C.G.G. Aitken (1976), “Multivariate binary discrimination by the kernel method,” Biometrika, 63, 413-420.
Hall, P. and J.S. Racine and Q. Li (2004), “Cross-validation and the estimation of conditional probability densities,” Journal of the American Statistical Association, 99, 1015-1026.
Hall, P. and J.S. Racine (2015), “Infinite Order Cross-Validated Local Polynomial Regression,” Journal of Econometrics, 185, 510-525.
Li, Q. and J.S. Racine (2007), Nonparametric Econometrics: Theory and Practice, Princeton University Press.
Li, A. and Q. Li and J.S. Racine (under revision), “Boundary Adjusted, Polynomial Adaptive, Nonparametric Kernel Conditional Density Estimation,” Econometric Reviews.
Pagan, A. and A. Ullah (1999), Nonparametric Econometrics, Cambridge University Press.
Scott, D.W. (1992), Multivariate Density Estimation. Theory, Practice and Visualization, New York: Wiley.
Silverman, B.W. (1986), Density Estimation, London: Chapman and Hall.
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.
Caution: multivariate data-driven bandwidth selection methods are, by
their nature, computationally intensive. Virtually all methods
require dropping the \(i\)th observation from the data set, computing an
object, repeating this for all observations in the sample, then
averaging each of these leave-one-out estimates for a given
value of the bandwidth vector, and only then repeating this a large
number of times in order to conduct multivariate numerical
minimization/maximization. Furthermore, due to the potential for local
minima/maxima, restarting this procedure a large number of times may
often be necessary. This can be frustrating for users possessing
large datasets. For exploratory purposes, you may wish to override the
default search tolerances, say, setting ftol=.01 and tol=.01 and
conduct multistarting (the default is to restart min(2, ncol(xdat,ydat))
times) as is done for a number of examples. Once the procedure
terminates, you can restart search with default tolerances using those
bandwidths obtained from the less rigorous search (i.e., set
bws=bw on subsequent calls to this routine where bw is
the initial bandwidth object). A version of this package using the
Rmpi wrapper is under development that allows one to deploy
this software in a clustered computing environment to facilitate
computation involving large datasets.
See also
np.kernels, np.options, plot, plot.np
bw.nrd, bw.SJ, hist,
npudens, npudist
Examples
if (FALSE) { # \dontrun{
# EXAMPLE 1 (INTERFACE=FORMULA): For this example, we compute the
# likelihood cross-validated bandwidths (default) using a second-order
# Gaussian kernel (default). Note - this may take a minute or two
# depending on the speed of your computer.
data("Italy")
Italy <- Italy[seq_len(min(300, nrow(Italy))), ]
with(Italy, {
bw <- npcdensbw(formula=gdp~ordered(year), nmulti=1)
# The object bw can be used for further estimation using
# npcdens(), plotting using plot() etc. Entering the name of
# the object provides useful summary information, and names() will also
# provide useful information.
summary(bw)
# Note - see the example for npudensbw() for multiple illustrations
# of how to change the kernel function, kernel order, and so forth.
})
# EXAMPLE 1 (INTERFACE=DATA FRAME): For this example, we compute the
# likelihood cross-validated bandwidths (default) using a second-order
# Gaussian kernel (default). Note - this may take a minute or two
# depending on the speed of your computer.
data("Italy")
Italy <- Italy[seq_len(min(300, nrow(Italy))), ]
with(Italy, {
bw <- npcdensbw(xdat=ordered(year), ydat=gdp, nmulti=1)
# The object bw can be used for further estimation using
# npcdens(), plotting using plot() etc. Entering the name of
# the object provides useful summary information, and names() will also
# provide useful information.
summary(bw)
# Note - see the example for npudensbw() for multiple illustrations
# of how to change the kernel function, kernel order, and so forth.
})
} # }