README

   1 RANGI
   2 =====
   3
   4 RANGI finds colored motifs in list-colored graphs.  You'll need a POSIX
   5 environment to compile this program.
   6
   7 To compile it, simply run make.  rangi is the main program:
   8
   9   $ make
  10     # compiles rangi, conv, and genrq
  11   $ ./rangi -h
  12     # shows available options
  13   $ ./rangi <test.dot
  14     # finds motifs of the largest size in test.dot
  15   $ ./rangi -s 10 <test.dot
  16     # finds motifs of size 10 in the graph specified in test.dot
  17   $ ./rangi -s 10+ <test.dot
  18     # finds largest motifs in test.dot starting from size 10
  19   $ ./rangi -s 10- <test.dot
  20     # finds largest motifs in test.dot that have at most 10 vertices
  21   $ ./rangi -s 10 -n 4 <test.dot
  22     # finds motifs of size 10 using 4 threads
  23
  24 Input graphs should be in RANGI graph format.
  25
  26 RANGI INPUT FORMAT
  27 ==================
  28
  29 RANGI expects the following format for the input list-colored graph:
  30
  31 * The first number in the file indicates the number of nodes.
  32 * Next, each of the nodes are described: the name of each node is
  33   followed by its list of colors terminated with -1, all separated
  34   with spaces.
  35 * The edges of the graph are described next: each edge is defined
  36   as a triple of the name of its endpoints and its weight.  The
  37   list of the edges are read until end of file is reached.
  38
  39 For instance the input file containing:
  40   4
  41   v1 1 -1
  42   v2 2 -1
  43   v3 3 -1
  44   v4 4 -1
  45   v1 v2 100
  46   v2 v3 200
  47   v3 v4 100
  48 Describes a graph with 4 nodes (v1 with color 1, v2 with color 2, v3 with
  49 color 3 and v4 with color 4) with three edges of weight 100, 200 and 100.
  50
  51 CREATING INPUT FILES
  52 ====================
  53
  54 The included mkrangi.sh script creates RANGI input files for
  55 protein interaction networks.  You'll need the blast program
  56 (http://www.ncbi.nih.gov/BLAST/); pre-compiled versions of blast are
  57 available in many fameous Linux distributions as blast2.
  58
  59 The biological files (network interactions, FASTA and
  60 complexes files) can be obtained from GraMoFoNe's website
  61 (http://igm.univ-mlv.fr/AlgoB/gramofone/).  I've already created RANGI
  62 input files for the networks in that page using blast2-2.2.24, which
  63 can be obtained from: http://ce.sharif.edu/~gholamirudi/rangi.dat.tar.gz
  64
  65 OTHER PROGRAMS
  66 ==============
  67
  68 * meval: counts the number of complexes containing a motif
  69 * genrq: generate random queries from a network
  70 * fastafilt: create a new FASTA based on the given complexes (mkrangi.sh)
  71 * bl2exp: extract blast E-values (mkrangi.sh)
  72 * conv: create RANGI input files from bl2exp output and queries (mkrangi.sh)