From 360cc10dcbe0b4e5cd62310a8fcc96cf9ce4b074 Mon Sep 17 00:00:00 2001 From: yifanhu Date: Thu, 17 Mar 2011 15:21:04 +0000 Subject: [PATCH] added man page for cluster --- cmd/gvmap/cluster.1 | 81 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 cmd/gvmap/cluster.1 diff --git a/cmd/gvmap/cluster.1 b/cmd/gvmap/cluster.1 new file mode 100644 index 000000000..f71471a00 --- /dev/null +++ b/cmd/gvmap/cluster.1 @@ -0,0 +1,81 @@ +.de TQ +. br +. ns +. TP \\$1 +.. +.TH CLUSTER 1 "3 March 2011" +.SH NAME +cluster \- find clusters in a graph and augment the graph with this information. +.SH SYNOPSIS +.B cluster +[\fB\-v?\fP] +[ +.I options +] +[ +.BI \-o +.I outfile +] +[ +.I files +] +.SH DESCRIPTION +.B cluster +takes as input a graph in DOT format, find node clusters and augment the graph with this information. +.B cluster +attempt to maximize the modularity of the clustering. +If edge "weight" is defined, this will be used in computing the clustering. +.SH OPTIONS +The following options are supported: +.TP +.BI \-v +Verbose mode. +.TP +.SH EXAMPLES +.PP +Applying +.B cluster +to the following graph, +.PP +.nf +\fB graph { + 1--2 [weight=10.] + 2--3 [weight=1] + 3--4 [weight=10.] + 4--5 [weight=10] + 5--6 [weight=10] + 3--6 [weight=0.1] + 4--6 [weight=10.] + }\fP +.fi +.PP +gives +.PP +.nf +\fB graph { + node [cluster="-1"]; + 1 [cluster=1]; + 2 [cluster=1]; + 3 [cluster=2]; + 4 [cluster=2]; + 5 [cluster=2]; + 6 [cluster=2]; + 1 -- 2 [weight="10."]; + 2 -- 3 [weight=1]; + 3 -- 4 [weight="10."]; + 4 -- 5 [weight=10]; + 5 -- 6 [weight=10]; + 3 -- 6 [weight="0.1"]; + 4 -- 6 [weight="10."]; + }\fP +.fi + + +.SH AUTHOR +Yifan Hu +.SH "SEE ALSO" +.PP +gvmap(1) +.PP + +Blondel, V.D., Guillaume, J.L., Lambiotte, R., Lefebvre, E.: Fast unfolding of communities in large networks. Journal of Statistical Mechanics: Theory and Experiment (2008), P10008. -- 2.40.0