Edge Clustering¶
Overview¶
-
class
EdgeClustering(communities: list, graph: object, method_name: str = '', method_parameters: dict = None, overlap: bool = False)¶ Edge Clustering representation.
Parameters: - communities – list of communities
- graph – a networkx/igraph object
- method_name – community discovery algorithm name
- method_parameters – configuration for the community discovery algorithm used
- overlap – boolean, whether the partition is overlapping or not
-
get_description(parameters_to_display: list = None, precision: int = 3) → str¶ Return a description of the clustering, with the name of the method and its numeric parameters.
Parameters: - parameters_to_display – parameters to display. By default, all float parameters.
- precision – precision used to plot parameters. default: 3
Returns: a string description of the method.
-
to_edge_community_map() → dict¶ Generate a <edge, list(communities)> representation of the current clustering
Returns: dict of the form <edge, list(communities)>
-
to_json() → str¶ Generate a JSON representation of the algorithms object
Returns: a JSON formatted string representing the object
Methods¶
Data transformation and IO¶
EdgeClustering.to_json() |
Generate a JSON representation of the algorithms object |
EdgeClustering.to_edge_community_map() |
Generate a <edge, list(communities)> representation of the current clustering |