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")

    KmknnParam_kmeans_args(x)

    ## S4 method for signature 'KmknnParam'
    show(object)

### Arguments

`...` | Arguments to be passed to `kmeans`.
`distance` | A string specifying the distance metric to use.
`x, object` | A KmknnParam object.

### 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.

### Value

The `KmknnParam` constructor will return an instance of the KmknnParam class.

The `KmknnParam_kmeans_args` function will return a list of named arguments, used in `...` to construct `object`.

### Author(s)

Aaron Lun

### See Also

`buildKmknn`

### Examples

    (out <- KmknnParam(iter.max=100))

    KmknnParam_kmeans_args(out)

[Package BiocNeighbors version 1.8.2 Index]