It estimates the percentage of correct classification via an m-fold cross valdiation. The bias is estimated as well using the algorithm suggested by Tibshirani and Tibshirani (2009) and is subtracted.

1 | ```
dirknn.tune(z, M = 10, A = 5, ina, type = "S", mesos = TRUE, mat = NULL)
``` |

`z` |
The data, a numeric matrix with unit vectors. |

`M` |
The number of folds for the m-fold cross validation, set to 10 by default. |

`A` |
The maximum number of nearest neighbours, set to 5 by default. The 1 nearest neighbour is not used. |

`ina` |
A variable indicating the groups of the data x. |

`type` |
If type is "S", the standard k-NN algorithm is to be used, else "NS" for the non standard one. See below (details) for more information. |

`mesos` |
A boolean variable used only in the case of the non standard algorithm (type="NS"). Should the average of the distances be calculated (TRUE) or not (FALSE)? If it is FALSE, the harmonic mean is calculated. |

`mat` |
You can specify your own folds by giving a mat, where each column is a fold. Each column contains indices of the observations. You can also leave it NULL and it will create folds. |

The standard algorithm is to keep the k nearest observations and see the groups of these observations. The new observation is allocated to the most frequent seen group. The non standard algorithm is to calculate the classical mean or the harmonic mean of the k nearest observations for each group. The new observation is allocated to the group with the smallest mean distance. The estimated bias is calculated as Tibshirani and Tibshirani (2009) suggested.

We have made an eficient (not very much efficient though) memory allocation. Even if you have hundreds of thousands of observations, the computer will not clush, it will only take longer. Instead of calcualte the distance matrix once in the beginning we calcualte the distances of the out-of-sample observations from the rest. If we calculated the distance matrix in the beginning, once, the resulting matrix could have dimensions thousands by thousands. This would not fit into the memory. If you have a few hundres of observations, the runtime is about the same (maybe less, maybe more) as calculating the distance matrix in the first place.

A list including:

`per` |
The average percent of correct classification across the neighbours. |

`percent` |
The bias corrected percent of correct classification. |

`runtime` |
The run time of the algorithm. A numeric vector. The first element is the user time, the second element is the system time and the third element is the elapsed time. |

Michail Tsagris R implementation and documentation: Michail Tsagris <mtsagris@yahoo.gr> and Giorgos Athineou <athineou@csd.uoc.gr>

Tibshirani, Ryan J., and Robert Tibshirani. A bias correction for the minimum error rate in cross-validation. The Annals of Applied Statistics (2009), 3(2): 822-829.

```
dirknn, vmf.da, mix.vmf
```

1 2 3 4 5 6 7 8 9 |

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

All documentation is copyright its authors; we didn't write any of that.