Options for cluster_leiden(). More...

#include <cluster_leiden.hpp>

Public Attributes
igraph_real_t	resolution = 1

igraph_real_t	beta = 0.01

igraph_int_t	iterations = 2

igraph_leiden_objective_t	objective = IGRAPH_LEIDEN_OBJECTIVE_CPM

bool	report_quality = true

igraph_uint_t	seed = 42

Detailed Description

Options for cluster_leiden().

Member Data Documentation

◆ resolution

igraph_real_t 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

igraph_real_t 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

igraph_int_t scran_graph_cluster::ClusterLeidenOptions::iterations = 2

Number of iterations of the Leiden algorithm. More iterations can improve separation at the cost of computational time. If negative, the algorithm will iterate until convergence. The default is based on ?cluster_leiden in the igraph R package.

◆ objective

igraph_leiden_objective_t scran_graph_cluster::ClusterLeidenOptions::objective = IGRAPH_LEIDEN_OBJECTIVE_CPM

Objective function to optimize. This should be one of IGRAPH_LEIDEN_OBJECTIVE_MODULARITY, IGRAPH_LEIDEN_OBJECTIVE_CPM or IGRAPH_LEIDEN_OBJECTIVE_ER. 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

igraph_uint_t 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