KmknnParam {BiocNeighbors} | R Documentation |
A class to hold parameters for the KMKNN algorithm for exact nearest neighbor identification.
KmknnParam(..., distance="Euclidean") KmknnParam_kmeans_args(x) ## S4 method for signature 'KmknnParam' show(object)
... |
Arguments to be passed to |
distance |
A string specifying the distance metric to use. |
x, object |
A KmknnParam object. |
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.
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
.
Aaron Lun
(out <- KmknnParam(iter.max=100)) KmknnParam_kmeans_args(out)