np.options: Global Package Options for 'np'

In np: Nonparametric Kernel Smoothing Methods for Mixed Data Types

Global Package Options for np

Description

Global options controlling selected computational and display behavior for the np package.

Details

Documentation guide: see np.kernels for kernels and plot for plotting options.

The following options are recognized by np.

• np.messages (logical): controls console/progress output. Default is TRUE.

• np.plot.progress (logical): controls bounded plot/bootstrap progress heartbeats. Default is TRUE.

• np.plot.progress.start.grace.sec (numeric): delay before the first plot/bootstrap progress line is shown. Default is 0.75.

• np.plot.progress.interval.sec (numeric): minimum elapsed time between plot/bootstrap heartbeat lines once progress reporting has started. Default is 0.5.

• np.plot.progress.max.intermediate (integer): maximum number of mid-run plot/bootstrap heartbeat lines emitted between the initial start notice and final completion line. Default is 3.

• np.tree (logical): enables kd-tree acceleration when supported by the selected kernel/operator combination. Default is FALSE.

• np.largeh.rel.tol (numeric): relative tolerance used by the continuous large-h shortcut. When all standardized distances for a continuous predictor are sufficiently close to zero, the corresponding kernel factor is approximated by K(0) to reduce repeated kernel evaluations. Default is 1e-3. Valid range is (0, 0.1).

• np.disc.upper.rel.tol (numeric): relative tolerance used by the discrete upper-bound shortcut for bandwidths near their feasible upper bounds. The near-upper check is applied relative to each kernel's own feasible upper bound (e.g., Aitchison-Aitken depends on category cardinality), with a tiny machine-precision floor for numerical robustness. When same/different-category kernel values are numerically close, the corresponding discrete kernel factor is treated as constant to reduce repeated category comparisons. Default is 1e-2. Valid range is (0, 0.5).

• plot.par.mfrow (logical): used by plot to determine whether plotting layout is automatically managed via par(mfrow=...). If NULL (default behavior), np uses its internal plotting defaults.

Option values can be set globally via options and restored with on.exit in scripts/functions for reproducibility.

Author(s)

Jeffrey S. Racine [e-mail]

See Also

np.kernels, plot np, plot, options

Examples

## Not run: 
old <- options(
  np.tree = TRUE,
  np.messages = FALSE,
  np.largeh.rel.tol = 1e-3,
  np.disc.upper.rel.tol = 1e-2
)
on.exit(options(old), add = TRUE)

## ... run bandwidth selection / estimation ...

## End(Not run)

np documentation built on May 3, 2026, 1:07 a.m.