scran_graph_cluster::ClusterMultilevelOptions Struct Reference

Options for cluster_multilevel(). More...

#include <cluster_multilevel.hpp>

Public Attributes
double	resolution = 1
int	seed = 42
bool	report_levels = true
bool	report_modularity = true

Detailed Description

Options for cluster_multilevel().

Member Data Documentation

resolution

double scran_graph_cluster::ClusterMultilevelOptions::resolution = 1

Resolution of the clustering, must be non-negative. Lower values favor fewer, larger communities; higher values favor more, smaller communities.

seed

int scran_graph_cluster::ClusterMultilevelOptions::seed = 42

Seed for the igraph random number generator.

report_levels

bool scran_graph_cluster::ClusterMultilevelOptions::report_levels = true

Whether to report the multi-level clusterings in Results::memberships.

report_modularity

bool scran_graph_cluster::ClusterMultilevelOptions::report_modularity = true

Whether to report the modularity for each level in Results::modularity.

---

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

• scran_graph_cluster/cluster_multilevel.hpp