meval: count the complexes containing a motif
[rangi.git] / README
blobea294b9513d88f5eaf823c92964f8c7c017e7b5e
1 RANGI
2 =====
4 RANGI finds colored motifs in list-colored graphs.  You'll need a POSIX
5 environment to compile this program.  To compile it, simply run make.
6 rangi is the main program:
8   $ make
9     # compiles rangi, conv, and genrq
10   $ ./rangi -h
11     # shows available options
12   $ ./rangi <test.dot
13     # finds motifs of the largest size in test.dot
14   $ ./rangi -s 10 <test.dot
15     # finds motifs of size 10 in the graph specified in test.dot
16   $ ./rangi -s 10+ <test.dot
17     # finds largest motifs in test.dot starting from size 10
18   $ ./rangi -s 10- <test.dot
19     # finds largest motifs in test.dot that have at most 10 vertices
20   $ ./rangi -s 10 -n 4 <test.dot
21     # finds motifs of size 10 using 4 threads
23 Input graphs can be in two formats: either the graphviz graph format, with
24 Betzler et al.'s extensions, like test0.dot, or our custom graph format,
25 as explained in the comments of readgraph() in rangi.c, like test1.rangi.
27 For generating a graph from the data sets included in
28 http://www.cs.tau.ac.il/~bnet/torque.html, download the archives
29 for any of the three mentioned species.  Then invoke:
31   $ ./conv -h
32     # shows available options
33   $ unzip DM_predef_torque.zip
34     # unzip any of the three datasets
35   $ ./conv -g -q query_interactions PROT1 PROT2 ... <input_network >graph.dot
36     # generate list-colored graph with the given queries in graphviz format
38 The -q option of conv expects the query interaction file, which lists the
39 BLAST score of each protein in the query with the proteins in the input
40 network (we have obtained these from Betzler et al.).  After options,
41 the name of the proteins in the query should be provided.
43 The graphs we generated using conv for testing rangi can be obtained from:
44 http://ce.sharif.edu/~gholamirudi/rangi.graphs.tar.gz
46 The genrq program generates random queries from a network.  These queries
47 can be passed to conv program to create an input graph with random
48 queries from the same network.  Note that conv removes the vertices in
49 the query from the network before generating the input graph, if queries
50 are selected from the same network and no -q option is provided.
52   $ ./genrq -h
53     # shows available options
54   $ ./genrq -n 10 -s 11 <network
55     # generates 10 queries of size 11 from the given network