Input-Output

Functions to save/load cdlib communities and events to/from file.

Community I/O

CSV format

The easiest way to save the result of a community discovery algorithm is to organize it in a .csv file. The following methods allow you to read/write communities to/from CSV.

read_community_csv(path[, delimiter, ...])	Read community list from comma separated value (csv) file.
write_community_csv(communities, path[, ...])	Save community structure to comma separated value (csv) file.

Note

CSV formatting allows only the saving/retrieving NodeClustering object to lose most of the metadata in the CD computation result - e.g., algorithm name, parameters, coverage…

JSON format

JSON format allows the storage/loading of community discovery algorithm results more comprehensively.

read_community_json(path[, compress])	Read community list from JSON file.
read_community_from_json_string(json_repr)	Read community list from JSON file.
write_community_json(communities, path[, ...])	Generate a JSON representation of the clustering object

Note

JSON formatting allows only saving/retrieving all kinds of Clustering objects and maintaining all their metadata - except for the graph object instance.

Community Events I/O

Events are a fundamental concept in the context of dynamic community discovery. The following methods allow you to read/write events to/from CSV.

read_lifecycle_json(path[, compress])	Read lifecycle from JSON file.
write_lifecycle_json(lifecycle, path[, compress])	Save lifecycle structure to JSON file.