Cross-Validation for the k-NN algorithm

Description Usage Arguments Details Value Author(s) References See Also Examples

View source: R/


Cross-Validation for the k-NN algorithm.


3 = NULL, nfolds = 10, stratified = FALSE, seed = FALSE, y, x, k, 
dist.type = "euclidean", type = "C", method = "average", freq.option = 0, 
pred.ret = FALSE, mem.eff = FALSE) 



A list with the indices of the folds.


The number of folds to be used. This is taken into consideration only if "folds" is NULL.


Do you want the folds to be selected using stratified random sampling? This preserves the analogy of the samples of each group. Make this TRUE if you wish, but only for the classification. If you have regression (type = "R"), do not put this to TRUE as it will cause problems or return wrong results.


If you set this to TRUE, the same folds will be created every time.


A vector of data. The response variable, which can be either continuous or categorical (factor is acceptable).


A matrix with the available data, the predictor variables.


A vector with the possible numbers of nearest neighbours to be considered.


The type of distance to be used, "euclidean" or "manhattan".


Do you want to do classification ("C") or regression ("R")?


If you do regression (type = "R"), then how should the predicted values be calculated? Choose among the average ("average"), median ("median") or the harmonic mean ("harmonic") of the closest neighbours.


If classification (type = "C") and ties occur in the prediction, more than one class have the same number of k nearest neighbours, there are three strategies available. Option 0 selects the first most frequent encountered. Option 1 randomly selects the most frequent value, in the case that there are duplicates.


If you want the predicted values returned set this to TRUE.


Boolean value indicating a conservative or not use of memory. Lower usage of memory/Having this option on will lead to a slight decrease in execution speed and should ideally be on when the amount of memory in demand might be a concern.


The concept behind k-NN is simple. Suppose we have a matrix with predictor variables and a vector with the response variable (numerical or categorical). When a new vector with observations (predictor variables) is available, its corresponding response value, numerical or categorical, is to be predicted. Instead of using a model, parametric or not, one can use this ad hoc algorithm.

The k smallest distances between the new predictor variables and the existing ones are calculated. In the case of regression, the average, median, or harmonic mean of the corresponding response values of these closest predictor values are calculated. In the case of classification, i.e. categorical response value, a voting rule is applied. The most frequent group (response value) is where the new observation is to be allocated.

This function does the cross-validation procedure to select the optimal k, the optimal number of nearest neighbours. The optimal in terms of some accuracy metric. For the classification it is the percentage of correct classification and for the regression the mean squared error.


A list including:


If pred.ret is TRUE the predicted values for each fold are returned as elements in a list.


A vector whose length is equal to the number of k and is the accuracy metric for each k.


Marios Dimitriadis

R implementation and documentation: Marios Dimitriadis <>


Friedman J., Hastie T. and Tibshirani R. (2017). The elements of statistical learning. New York: Springer.

Cover TM and Hart PE (1967). Nearest neighbor pattern classification. IEEE Transactions on Information Theory. 13(1):21-27.

Tsagris Michail, Simon Preston and Andrew T.A. Wood (2016). Improved classification for compositional data using the α-transformation. Journal of classification 33(2): 243-261.

See Also

knn, Dist, dista,


x <- as.matrix(iris[, 1:4])
y <- iris[, 5]
mod <- = NULL, nfolds = 10, stratified = TRUE, seed = FALSE, y = y, x = x, 
k = c(3, 4), dist.type = "euclidean", type = "C", method = "average", 
freq.option = 0, pred.ret = FALSE, mem.eff = FALSE) 

Example output

Loading required package: Rcpp
Loading required package: RcppZiggurat

Rfast documentation built on Dec. 11, 2021, 9:59 a.m.