Skip to content

Commit 8079cb0

Browse files
added the list of parameters
1 parent 1b4b589 commit 8079cb0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,19 @@ cpm.text()
2727
cpm.test_karate()
2828
```
2929

30+
# Parameters
31+
* **graph** : igraph object
32+
The _igraph object_ containing the graph.
33+
* **k** : int, optional
34+
Size of the clique. The default is _3_.
35+
* **workers** : int, optional
36+
Number of threads to allocate for running this algorithm. The default is _1_.
37+
* **attribute** : str, optional
38+
The attribute of the vertices to use for displaying nodes within the communities.
39+
For displaying purposes, if vertices have names, the latter can be quite handy to figure out which node belongs to a certain community.
40+
If no attribute is given, the algorithm will display their id. The default is _None_.
41+
* **verbose** : bool, optional
42+
If set to _True_ it shows status updates. The default is _False_.
43+
3044
# Reference
3145
Palla, Gergely, Imre Derényi, Illés Farkas, and Tamás Vicsek. "Uncovering the overlapping community structure of complex networks in nature and society." Nature 435, no. 7043 (2005): 814-818.

0 commit comments

Comments
 (0)