annotate commons/tools/dbConsensus.py @ 18:94ab73e8a190

Uploaded
author m-zytnicki
date Mon, 29 Apr 2013 03:20:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
1 #!/usr/bin/env python
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
2
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
3 # Copyright INRA (Institut National de la Recherche Agronomique)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
4 # http://www.inra.fr
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
5 # http://urgi.versailles.inra.fr
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
6 #
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
7 # This software is governed by the CeCILL license under French law and
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
8 # abiding by the rules of distribution of free software. You can use,
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
9 # modify and/ or redistribute the software under the terms of the CeCILL
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
10 # license as circulated by CEA, CNRS and INRIA at the following URL
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
11 # "http://www.cecill.info".
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
12 #
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
13 # As a counterpart to the access to the source code and rights to copy,
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
14 # modify and redistribute granted by the license, users are provided only
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
15 # with a limited warranty and the software's author, the holder of the
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
16 # economic rights, and the successive licensors have only limited
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
17 # liability.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
18 #
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
19 # In this respect, the user's attention is drawn to the risks associated
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
20 # with loading, using, modifying and/or developing or reproducing the
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
21 # software by the user in light of its specific status of free software,
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
22 # that may mean that it is complicated to manipulate, and that also
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
23 # therefore means that it is reserved for developers and experienced
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
24 # professionals having in-depth computer knowledge. Users are therefore
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
25 # encouraged to load and test the software's suitability as regards their
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
26 # requirements in conditions enabling the security of their systems and/or
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
27 # data to be ensured and, more generally, to use and operate it in the
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
28 # same conditions as regards security.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
29 #
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
30 # The fact that you are presently reading this means that you have had
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
31 # knowledge of the CeCILL license and that you accept its terms.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
32
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
33 import os
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
34 import sys
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
35 import getopt
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
36
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
37 ##@file
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
38 # usage: dbConsensus.py [ options ]
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
39 # options:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
40 # -h: this help
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
41 # -i: name of the input file (format=aligned fasta)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
42 # -n: minimum number of nucleotides in a column to edit a consensus (default=1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
43 # -p: minimum proportion for the major nucleotide to be used, otherwise add 'N' (default=0.0)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
44 # -o: name of the output file (default=inFileName+'.cons')
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
45 # -v: verbose (default=0/1/2)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
46
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
47 if not os.environ.has_key( "REPET_PATH" ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
48 print "ERROR: no environment variable REPET_PATH"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
49 sys.exit(1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
50 sys.path.append( os.environ["REPET_PATH"] )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
51
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
52 import commons.core.seq.AlignedBioseqDB
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
53
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
54
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
55 def help():
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
56 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
57 Give the list of the command-line options.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
58 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
59 print
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
60 print "usage:",sys.argv[0]," [ options ]"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
61 print "options:"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
62 print " -h: this help"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
63 print " -i: name of the input file (format=aligned fasta)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
64 print " -n: minimum number of nucleotides in a column to edit a consensus (default=1)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
65 print " -p: minimum proportion for the major nucleotide to be used, otherwise add 'N' (default=0.0)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
66 print " -o: name of the output file (default=inFileName+'.cons')"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
67 print " -H: format the header with pyramid and piles informations (SATannot)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
68 print " -v: verbose (default=0/1/2)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
69 print
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
70
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
71
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
72 def main():
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
73
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
74 inFileName = ""
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
75 minNbNt = 1
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
76 minPropNt = 0.0
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
77 outFileName = ""
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
78 header_SATannot = False
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
79 verbose = 0
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
80
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
81 try:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
82 opts, args = getopt.getopt(sys.argv[1:],"hi:n:p:o:v:H")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
83 except getopt.GetoptError, err:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
84 print str(err); help(); sys.exit(1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
85 for o,a in opts:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
86 if o == "-h":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
87 help()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
88 sys.exit(0)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
89 elif o == "-i":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
90 inFileName = a
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
91 elif o == "-n":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
92 minNbNt = int(a)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
93 elif o == "-p":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
94 minPropNt = float(a)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
95 elif o == "-o":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
96 outFileName = a
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
97 elif o == "-H":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
98 header_SATannot = True
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
99 elif o == "-v":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
100 verbose = int(a)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
101
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
102 if inFileName == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
103 print "ERROR: missing input file name"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
104 help()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
105 sys.exit(1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
106
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
107 if verbose > 0:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
108 print "START %s" % (sys.argv[0].split("/")[-1])
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
109 sys.stdout.flush()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
110
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
111 alnDB = commons.core.seq.AlignedBioseqDB.AlignedBioseqDB( inFileName )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
112
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
113 if alnDB.getSize() < minNbNt:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
114 print "WARNING: not enough sequences (<%i)" % ( minNbNt )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
115
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
116 else:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
117 consensus = alnDB.getConsensus( minNbNt, minPropNt, verbose, header_SATannot)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
118 if consensus != None:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
119 consensus.upCase()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
120 if outFileName == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
121 outFileName = "%s.cons" % ( inFileName )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
122 outFile = open( outFileName, "w" )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
123 consensus.write( outFile )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
124 outFile.close()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
125
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
126 if verbose > 0:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
127 print "END %s" % (sys.argv[0].split("/")[-1])
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
128 sys.stdout.flush()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
129
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
130 return 0
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
131
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
132 if __name__ == "__main__":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
133 main ()