R: Build a nearest-neighbor index

buildNNIndex {BiocNeighbors}

R Documentation

Build a nearest-neighbor index

Build indices for nearest-neighbor searching with different algorithms.

buildNNIndex(..., BNPARAM=NULL)

`...`	Further arguments to be passed to individual methods. The mandatory argument for all methods is `X`, a numeric matrix where rows correspond to data points and columns correspond to variables (i.e., dimensions).
`BNPARAM`	A BiocNeighborParam object specifying the type of index to be constructed. This defaults to a KmknnParam object if `NULL`.

Supplying a KmknnParam object as BNPARAM will dispatch to buildKmknn.

Supplying an AnnoyParam object as BNPARAM will dispatch to buildAnnoy.

A BiocNeighborIndex object containing indexing structures for each algorithm.

Aaron Lun

Y <- matrix(rnorm(100000), ncol=20)
(k.out <- buildNNIndex(Y))
(a.out <- buildNNIndex(Y, BNPARAM=AnnoyParam()))

[Package BiocNeighbors version 1.0.0 Index]