AnnoyParam: The AnnoyParam class

In BiocNeighbors: Nearest Neighbor Detection for Bioconductor Packages

Description

A class to hold parameters for the Annoy algorithm for approximate nearest neighbor identification.

Usage

AnnoyParam(ntrees=50, directory=tempdir(), search.mult=ntrees, distance="Euclidean")

AnnoyParam_ntrees(x)

AnnoyParam_directory(x)

AnnoyParam_search_mult(x)

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

Arguments

ntrees	Integer scalar, number of trees to use for index generation.
directory	String, the directory in which to save the index.
search.mult	Numeric scalar, multiplier for the number of points to search.
distance	String, the distance metric to use.
x, object	A AnnoyParam object.

Details

The AnnoyParam class holds any parameters associated with running the Annoy algorithm. This generally relates to building of the index - see buildAnnoy for details.

Value

The AnnoyParam constructor will return an instance of the AnnoyParam class.

AnnoyParam_ntrees will return the number of trees as an integer scalar.

AnnoyParam_directory will return the directory as a string.

AnnoyParam_search_mult will return the multiplier for the number of points to search.

Author(s)

Aaron Lun

See Also

buildAnnoy

Examples

(out <- AnnoyParam())

AnnoyParam_ntrees(out)
AnnoyParam_directory(out)

BiocNeighbors documentation built on Dec. 9, 2020, 2:01 a.m.