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
  11   $ ./rangi -h
  12     # shows available options
  13   $ ./rangi <test1.rangi
  14     # finds motifs of the largest size in test1.rangi
  15   $ ./rangi -s 3 <test1.rangi
  16     # finds motifs of size 3 in the graph specified in test1.rangi
  17   $ ./rangi -s 3+ <test1.rangi
  18     # finds largest motifs in test1.rangi starting from size 3
  19   $ ./rangi -s 3- <test1.rangi
  20     # finds largest motifs in test1.rangi that have at most 3 vertices
  21   $ ./rangi -s 3 -n 4 <test1.rangi
  22     # finds motifs of size 3 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
  41   4
  42   v1 1 -1
  43   v2 2 -1
  44   v3 3 -1
  45   v4 4 -1
  46   v1 v2 100
  47   v2 v3 200
  48   v3 v4 100
  49
  50 Describes a graph with 4 nodes (v1 with color 1, v2 with color 2, v3 with
  51 color 3 and v4 with color 4) with three edges of weight 100, 200 and 100.
  52
  53 CREATING INPUT FILES
  54 ====================
  55
  56 The included mkrangi.sh script creates RANGI input files for
  57 protein interaction networks.  You'll need the blast program
  58 (http://www.ncbi.nih.gov/BLAST/); pre-compiled versions of blast are
  59 available in many fameous Linux distributions as blast2.
  60
  61 The biological files (network interactions, FASTA and
  62 complexes files) can be obtained from GraMoFoNe's website
  63 (http://igm.univ-mlv.fr/AlgoB/gramofone/).  I've already created RANGI
  64 input files for the networks in that page using blast2-2.2.24, which
  65 can be obtained from: http://litcave.rudi.ir/rangi.dat.tar.gz
  66
  67 OTHER PROGRAMS
  68 ==============
  69
  70 * meval: counts the number of complexes containing a motif
  71 * genrq: generate random queries from a network
  72 * fastafilt: create a new FASTA based on the given complexes (mkrangi.sh)
  73 * bl2exp: extract blast E-values (mkrangi.sh)
  74 * conv: create RANGI input files from bl2exp output and queries (mkrangi.sh)