nearest_neighbor: K-nearest neighbors

View source: R/nearest_neighbor.R

nearest_neighborR Documentation

K-nearest neighbors


nearest_neighbor() defines a model that uses the K most similar data points from the training set to predict new samples. This function can fit classification and regression models.


More information on how parsnip is used for modeling is at


  mode = "unknown",
  engine = "kknn",
  neighbors = NULL,
  weight_func = NULL,
  dist_power = NULL



A single character string for the prediction outcome mode. Possible values for this model are "unknown", "regression", or "classification".


A single character string specifying what computational engine to use for fitting.


A single integer for the number of neighbors to consider (often called k). For kknn, a value of 5 is used if neighbors is not specified.


A single character for the type of kernel function used to weight distances between samples. Valid choices are: "rectangular", "triangular", "epanechnikov", "biweight", "triweight", "cos", "inv", "gaussian", "rank", or "optimal".


A single number for the parameter used in calculating Minkowski distance.


This function only defines what type of model is being fit. Once an engine is specified, the method to fit the model is also defined. See set_engine() for more on setting the engine, including how to set engine arguments.

The model is not trained or fit until the fit() function is used with the data.

Each of the arguments in this function other than mode and engine are captured as quosures. To pass values programmatically, use the injection operator like so:

value <- 1
nearest_neighbor(argument = !!value)

References, Tidy Modeling with R, searchable table of parsnip models

See Also




nearest_neighbor(neighbors = 11)

parsnip documentation built on June 24, 2024, 5:14 p.m.