Result of the igraph Walktrap community detection algorithm. More...

#include <ClusterSnnGraph.hpp>

Public Attributes
int	status = 0

std::vector< int >	membership

std::vector< std::pair< int, int > >	merges

std::vector< double >	modularity

Detailed Description

Result of the igraph Walktrap community detection algorithm.

Instances should be constructed using the ClusterSnnGraphWalktrap::run() methods.

Member Data Documentation

◆ status

int scran::ClusterSnnGraphWalktrap::Results::status = 0

Output status. A value of zero indicates that the algorithm completed successfully.

◆ membership

std::vector<int> scran::ClusterSnnGraphWalktrap::Results::membership

Vector of length equal to the number of cells, containing 0-indexed cluster identities.

◆ merges

std::vector<std::pair<int, int> > scran::ClusterSnnGraphWalktrap::Results::merges

Vector of length equal to the number of merge steps, containing the identities of the two clusters being merged. Note that cluster IDs here are not the same as those in membership.

◆ modularity

std::vector<double> scran::ClusterSnnGraphWalktrap::Results::modularity

Vector of length equal to merges plus 1, containing the modularity score before and after each merge step. The maximum value is the modularity corresponding to the clustering in membership.

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