scran_graph_cluster::BuildSnnGraphOptions Struct Reference

Options for SNN graph construction. More...

#include <build_snn_graph.hpp>

Public Attributes
int	num_neighbors = 10
SnnWeightScheme	weighting_scheme = SnnWeightScheme::RANKED
int	num_threads = 1

Detailed Description

Options for SNN graph construction.

Member Data Documentation

num_neighbors

int scran_graph_cluster::BuildSnnGraphOptions::num_neighbors = 10

The number of nearest neighbors to use for graph construction. Larger values increase the connectivity of the graph and reduce the granularity of subsequent community detection steps, at the cost of speed. Only relevant for the build_snn_graph() overloads without pre-computed neighbors.

weighting_scheme

SnnWeightScheme scran_graph_cluster::BuildSnnGraphOptions::weighting_scheme = SnnWeightScheme::RANKED

Weighting scheme for each edge, based on the number of shared nearest neighbors of the two nodes.

num_threads

int scran_graph_cluster::BuildSnnGraphOptions::num_threads = 1

Number of threads to use. The parallelization scheme is defined by knncolle::parallelize().

---

The documentation for this struct was generated from the following file:

• scran_graph_cluster/build_snn_graph.hpp