Options for cluster_leiden(). More...

#include <cluster_leiden.hpp>

Public Attributes
double	resolution = 1

double	beta = 0.01

int	iterations = 2

bool	modularity = false

bool	report_quality = true

int	seed = 42

Detailed Description

Options for cluster_leiden().

Member Data Documentation

◆ resolution

double scran_graph_cluster::ClusterLeidenOptions::resolution = 1

Resolution of the clustering. Larger values result in more fine-grained communities. The default is based on ?cluster_leiden in the igraph R package.

◆ beta

double scran_graph_cluster::ClusterLeidenOptions::beta = 0.01

Level of randomness used during refinement. The default is based on ?cluster_leiden in the igraph R package.

◆ iterations

int scran_graph_cluster::ClusterLeidenOptions::iterations = 2

Number of iterations of the Leiden algorithm. More iterations can improve separation at the cost of computational time. The default is based on ?cluster_leiden in the igraph R package.

◆ modularity

bool scran_graph_cluster::ClusterLeidenOptions::modularity = false

Whether to optimize the modularity instead of the Constant Potts Model (CPM). The two are closely related but the magnitude of the resolution is different - CPM typically yields more fine-grained clusters at the same choice of ClusterLeidenOptions::resolution. The default is based on ?cluster_leiden in the igraph R package.

◆ report_quality

bool scran_graph_cluster::ClusterLeidenOptions::report_quality = true

Whether to report the quality of the clustering in Results::quality.

◆ seed

int scran_graph_cluster::ClusterLeidenOptions::seed = 42

Seed for the igraph random number generator.

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

scran_graph_cluster/cluster_leiden.hpp

Public Attributes