Package: BiocNeighbors 2.7.2

Aaron Lun

BiocNeighbors: Nearest Neighbor Detection for Bioconductor Packages

Implements exact and approximate methods for nearest neighbor detection, in a framework that allows them to be easily switched within Bioconductor packages or workflows. Exact searches can be performed using the k-means for k-nearest neighbors algorithm, vantage point trees, or an exhaustive search. Approximate searches can be performed using the Annoy or HNSW libraries. Each search can be performed with a variety of different distance metrics, parallelization, and variable numbers of neighbors. Range-based searches (to find all neighbors within a certain distance) are also supported.

Authors:Aaron Lun [aut, cre, cph]

BiocNeighbors_2.7.2.tar.gz
BiocNeighbors_2.7.2.zip(r-4.7)BiocNeighbors_2.7.2.zip(r-4.6)BiocNeighbors_2.7.2.zip(r-4.5)
BiocNeighbors_2.7.2.tgz(r-4.6-x86_64)BiocNeighbors_2.7.2.tgz(r-4.6-arm64)BiocNeighbors_2.7.2.tgz(r-4.5-x86_64)BiocNeighbors_2.7.2.tgz(r-4.5-arm64)
BiocNeighbors_2.7.2.tar.gz(r-4.7-arm64)BiocNeighbors_2.7.2.tar.gz(r-4.7-x86_64)BiocNeighbors_2.7.2.tar.gz(r-4.6-arm64)BiocNeighbors_2.7.2.tar.gz(r-4.6-x86_64)
BiocNeighbors_2.7.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html
card.svg |card.png
BiocNeighbors/json (API)
NEWS

# Install 'BiocNeighbors' in R:
install.packages('BiocNeighbors', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/knncolle/biocneighbors/issues

Uses libs:
  • c++– GNU Standard C++ Library v3

On BioConductor:BiocNeighbors-2.7.2(bioc 3.24)BiocNeighbors-2.6.0(bioc 3.23)

clusteringclassificationbioconductor-packagehuman-cell-atlasnearest-neighbor-searchcpp

11.82 score 6 stars 109 packages 826 scripts 20k downloads 36 exports 16 dependencies

Last updated from:b17cc73d44. Checks:1 WARNING, 13 OK. Indexed: yes.

TargetResultTimeFilesSyslog
bioc-checksWARNING166
linux-devel-arm64OK229
linux-devel-x86_64OK229
source / vignettesOK246
linux-release-arm64OK355
linux-release-x86_64OK255
macos-release-arm64OK142
macos-release-x86_64OK288
macos-oldrel-arm64OK148
macos-oldrel-x86_64OK343
windows-develOK188
windows-releaseOK191
windows-oldrelOK179
wasm-releaseOK154

Exports:AnnoyIndexAnnoyParambndistancebuildIndexdefineBuilderExhaustiveIndexExhaustiveParamfindDistancefindDistanceFromIndexfindKNNfindKnnFromIndexfindMutualNNfindNeighborsfindNeighborsFromIndexfindResultsToHitsfindResultsToMatrixgetLoadGenericIndexRegistryHnswIndexHnswParamKmknnIndexKmknnParamloadIndexqueryDistancequeryDistanceFromIndexqueryKNNqueryKnnFromIndexqueryNeighborsqueryNeighborsFromIndexqueryResultsToHitsqueryResultsToMatrixregisterLoadGenericIndexClassregisterLoadIndexFunctionsaveIndexshowVptreeIndexVptreeParam

Dependencies:abindassortheadbeachmatBiocGenericsDelayedArraygenericsIRangeslatticeMatrixMatrixGenericsmatrixStatsRcppS4ArraysS4VectorsSparseArrayXVector

Finding neighbors in high-dimensional space

Rendered fromuserguide.Rmdusingknitr::rmarkdownon Jun 09 2026.

Last update: 2026-01-31
Started: 2024-09-05

Readme and manuals

Help Manual

Help pageTopics
BiocNeighbors: Nearest Neighbor Detection for Bioconductor PackagesBiocNeighbors-package BiocNeighbors
The AnnoyParam classAnnoyIndex AnnoyIndex-class AnnoyParam AnnoyParam-class defineBuilder,AnnoyParam-method show,AnnoyParam-method
The BiocNeighborIndex classBiocNeighborGenericIndex-class BiocNeighborIndex BiocNeighborIndex-class show,BiocNeighborIndex-method
The BiocNeighborParam classBiocNeighborParam BiocNeighborParam-class bndistance show,BiocNeighborParam-method [[,BiocNeighborParam-method [[<-,BiocNeighborParam-method
Build a nearest-neighbor indexbuildIndex buildIndex,BiocNeighborParam-method buildIndex,list-method buildIndex,missing-method buildIndex,NULL-method
Define an index builderdefineBuilder defineBuilder,missing-method defineBuilder,NULL-method
The ExhaustiveParam classdefineBuilder,ExhaustiveParam-method ExhaustiveIndex ExhaustiveIndex-class ExhaustiveParam ExhaustiveParam-class
Distance to the k-th nearest neighborfindDistance findDistanceFromIndex findDistanceFromIndex,BiocNeighborGenericIndex-method
Find k-nearest neighborsfindKNN findKnnFromIndex findKnnFromIndex,BiocNeighborGenericIndex-method
Find mutual nearest neighborsfindMutualNN
Find neighbors within a threshold distancefindNeighbors findNeighborsFromIndex findNeighborsFromIndex,BiocNeighborGenericIndex-method
Convert neighbor search results to alternative representationsfindResultsToHits findResultsToMatrix queryResultsToHits queryResultsToMatrix
Load indices from extension packagesgetLoadGenericIndexRegistry registerLoadGenericIndexClass registerLoadIndexFunction
The HnswParam classdefineBuilder,HnswParam-method HnswIndex HnswIndex-class HnswParam HnswParam-class show,HnswParam-method
The KmknnParam classdefineBuilder,KmknnParam-method KmknnIndex KmknnIndex-class KmknnParam KmknnParam-class
Load a prebuilt search index from diskloadIndex
Distance to the k-th nearest neighbor to query pointsqueryDistance queryDistanceFromIndex queryDistanceFromIndex,BiocNeighborGenericIndex-method
Query k-nearest neighborsqueryKNN queryKnnFromIndex queryKnnFromIndex,BiocNeighborGenericIndex-method
Query neighbors within a threshold distancequeryNeighbors queryNeighborsFromIndex queryNeighborsFromIndex,BiocNeighborGenericIndex-method
Save a nearest-neighbor indexsaveIndex saveIndex,BiocNeighborGenericIndex-method
The VptreeParam classdefineBuilder,VptreeParam-method VptreeIndex VptreeIndex-class VptreeParam VptreeParam-class