KmknnParam: The KmknnParam class

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

View source: R/KmknnParam-class.R

Description

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

Usage

1
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

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

LTLA/BiocNeighbors documentation built on Sept. 18, 2021, 8:19 p.m.