AnnoyParam {BiocNeighbors}R Documentation

The AnnoyParam class

Description

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

Usage

AnnoyParam(ntrees=50, directory=tempdir())

AnnoyParam_ntrees(x)

AnnoyParam_directory(x)

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

Arguments

ntrees

Integer scalar, number of trees to use for index generation.

directory

String specifying the directory in which to save the index.

x, object

A AnnoyParam object.

Details

The AnnoyParam class holds any parameters associated with running the Annoy algorithm. Currently, this 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.

Author(s)

Aaron Lun

See Also

buildAnnoy

Examples

(out <- AnnoyParam())

AnnoyParam_ntrees(out)
AnnoyParam_directory(out)

[Package BiocNeighbors version 1.0.0 Index]