KmknnParam {BiocNeighbors} | R Documentation

## The KmknnParam class

### Description

A class to hold parameters for the KMKNN algorithm for exact nearest neighbor identification.

### Usage

    KmknnParam(..., distance = "Euclidean")

### Arguments

`...` | Arguments to be passed to `kmeans`.
`distance` | A string specifying the distance metric to use.

### Details

The KmknnParam class holds any parameters associated with running the KMKNN algorithm. Currently, this relates to tuning of the k-means step - see `buildKmknn` for details.

Users can get or set values from an KmknnParam object with the usual `[[` syntax. All parameters listed in `...` are available via `x[['kmeans.args']]`.

### Value

An instance of the KmknnParam class.

### Author(s)

Aaron Lun

### See Also

`buildKmknn`, for the index construction.

`findKmknn` and related functions, for the actual search.

BiocNeighborParam, for the parent class and its available methods.

### Examples

    (out <- KmknnParam(iter.max=100))
    out[['kmeans.args']]

[Package BiocNeighbors version 1.12.0 Index]