make_nn_index: Make a nearest neighbor index.

View source: R/nearest_neighbors.R

make_nn_indexR Documentation

Make a nearest neighbor index.

Description

Make a nearest neighbor index from the subject_matrix using either the default nearest neighbor method or the method specified in the nn_control list parameter. The function returns the index.

Usage

make_nn_index(subject_matrix, nn_control = list(), verbose = FALSE)

Arguments

subject_matrix

the matrix used to build the index.

nn_control

a list of parameters used to make the nearest neighbor index. See the set_nn_control help for details.

verbose

a boolean indicating whether to emit verbose output.

Value

a nearest neighbor index.

Examples

  
    cds <- load_a549()
    cds <- preprocess_cds(cds)
    nn_index <- make_nn_index(SingleCellExperiment::reducedDims(cds)[['PCA']])
  


cole-trapnell-lab/monocle3 documentation built on April 7, 2024, 9:24 p.m.