Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

cluster (1)

Name

cluster - find clusters in a graph and augment the graph with this information.

Synopsis

cluster [-v?]  [ -Ck ] [ -o outfile ] [ files ]

Description

CLUSTER(1)                  General Commands Manual                 CLUSTER(1)



NAME
       cluster  -  find  clusters  in  a graph and augment the graph with this
       information.

SYNOPSIS
       cluster [-v?]  [ -Ck ] [ -o outfile ] [ files ]

DESCRIPTION
       cluster takes as input a graph in DOT format, finds node  clusters  and
       augments  the  graph with this information.  The clusters are specified
       by the "cluster" attribute attached to nodes; cluster values  are  non-
       negative  integers.  cluster attempts to maximize the modularity of the
       clustering.  If the edge attribute "weight" is defined,  this  will  be
       used in computing the clustering.

OPTIONS
       The following options are supported:

       -Ck    specifies  a  targeted  number of clusters that should be gener-
              ated.  The specified number k is only a suggestion and  may  not
              be  realisable.   If k == 0, the default, the number of clusters
              that approximately optimizes the modularity is returned.

       -ooutfile
              Specifies that output  should  go  into  the  file  outfile.  By
              default, stdout is used.

       -v     Verbose mode.

EXAMPLES
       Applying cluster to the following graph,

          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.]
             }

       gives

          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."];
          }



AUTHOR
       Yifan Hu <yifanhu@research.att.com>


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | image/graphviz   |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       gvmap(1)

       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.



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source  was  downloaded from  http://www.graphviz.org/pub/graphviz/sta-
       ble/SOURCES/graphviz-2.28.0.tar.gz

       Further information about this software can be found on the open source
       community website at http://www.graphviz.org/.



                                 3 March 2011                       CLUSTER(1)