annotate commons/launcher/LaunchTRF.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 from commons.core.LoggerFactory import LoggerFactory
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
34 from commons.core.utils.RepetOptionParser import RepetOptionParser
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
35 from commons.core.checker.ConfigChecker import ConfigRules
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
36 from commons.core.checker.ConfigChecker import ConfigChecker
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
37 import subprocess
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
38 import glob
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
39 import os
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
40
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
41 LOG_DEPTH = "repet.launchers"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
42
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
43 class LaunchTRF(object):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
44
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
45 def __init__(self, inFileName = "", outFileName = "", maxPeriod=15, doClean = False, verbosity = 0):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
46 self.inFileName = inFileName
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
47 self.setOutFileName(outFileName)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
48 self.maxPeriod=maxPeriod
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
49 self._doClean = doClean
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
50 self._verbosity = verbosity
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
51 self._log = LoggerFactory.createLogger("%s.%s" % (LOG_DEPTH, self.__class__.__name__), self._verbosity)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
52
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
53 def setAttributesFromCmdLine(self):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
54 description = "Launch TRF to detect micro-satellites in sequences."
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
55 epilog = "\nExample 1: launch without verbosity and keep temporary files.\n"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
56 epilog += "\t$ python LaunchTemplate.py -i file.fa -v 0"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
57 epilog += "\n\t"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
58 parser = RepetOptionParser(description = description, epilog = epilog)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
59 parser.add_option("-i", "--in", dest = "inFileName", action = "store", type = "string", help = "input file name [compulsory] [format: fasta]", default = "")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
60 parser.add_option("-o", "--out", dest = "outFileName", action = "store", type = "string", help = "output file name [default: <input>.TRF.set]", default = "")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
61 parser.add_option("-m", "--maxPeriod", dest = "maxPeriod", action = "store", type = "int", help = " maximum period size to report [default: 15]", default = 15)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
62 parser.add_option("-c", "--clean", dest = "doClean", action = "store_true", help = "clean temporary files [optional] [default: False]", default = False)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
63 parser.add_option("-v", "--verbosity", dest = "verbosity", action = "store", type = "int", help = "verbosity [optional] [default: 1]", default = 1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
64 options = parser.parse_args()[0]
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
65 self._setAttributesFromOptions(options)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
66
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
67 def _setAttributesFromOptions(self, options):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
68 self.setInFileName(options.inFileName)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
69 self.setOutFileName(options.outFileName)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
70 self.maxPeriod = options.maxPeriod
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
71 self.setDoClean(options.doClean)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
72 self.setVerbosity(options.verbosity)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
73
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
74 def setInFileName(self, inFileName):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
75 self.inFileName = inFileName
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
76
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
77 def setOutFileName(self, outFileName):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
78 if outFileName == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
79 self._outFileName = "%s.TRF.set" % self.inFileName
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
80 else:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
81 self._outFileName = outFileName
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
82
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
83 def setDoClean(self, doClean):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
84 self._doClean = doClean
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
85
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
86 def setVerbosity(self, verbosity):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
87 self._verbosity = verbosity
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
88
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
89 def _checkOptions(self):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
90 if self.inFileName == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
91 self._logAndRaise("ERROR: Missing input file name")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
92
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
93 def _logAndRaise(self, errorMsg):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
94 self._log.error(errorMsg)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
95 raise Exception(errorMsg)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
96
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
97
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
98 def _launchTRF(self):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
99 cmd = "trf %s 2 3 5 80 10 20 %d -h -d" % (self.inFileName, self.maxPeriod)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
100 self._log.debug("Running : %s" % cmd)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
101 process = subprocess.Popen(cmd.split(' '), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
102 output = process.communicate()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
103 self._log.debug("Output:\n%s" % output[0])
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
104
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
105 def _parseTRF(self):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
106 self._log.debug("Parsing TRF output")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
107 with open( "%s.2.3.5.80.10.20.%d.dat" % (self.inFileName, self.maxPeriod),'r') as inFile:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
108 with open(self._outFileName,'w') as outFile:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
109 nbPatterns = 0
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
110 nbInSeq = 0
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
111 for line in inFile.readlines():
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
112 if line == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
113 break
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
114 data = line.split(" ")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
115 if len(data) > 1 and "Sequence:" in data[0]:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
116 nbInSeq += 1
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
117 seqName = data[1][:-1]
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
118 if len(data) < 14:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
119 continue
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
120 nbPatterns += 1
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
121 consensus = data[13]
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
122 copyNb = int( float(data[3]) + 0.5 )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
123 start = data[0]
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
124 end = data[1]
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
125 outFile.write( "%i\t(%s)%i\t%s\t%s\t%s\n" % ( nbPatterns, consensus, copyNb, seqName, start, end ) )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
126 self._log.debug("Finished Parsing TRF output")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
127
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
128 def _clean(self):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
129 try:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
130 os.remove("%s.2.3.5.80.10.20.%d.dat" % (self.inFileName, self.maxPeriod))
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
131 except:pass
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
132
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
133
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
134 def run(self):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
135 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
136 Launch TRF to detect micro-satellites in sequences.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
137 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
138 LoggerFactory.setLevel(self._log, self._verbosity)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
139 self._checkOptions()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
140 self._log.info("START Launch")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
141 self._log.debug("Input file name: %s" % self.inFileName)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
142
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
143 self._launchTRF()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
144 self._parseTRF()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
145
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
146 if self._doClean:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
147 self._log.warning("Files will be cleaned")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
148 self._clean()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
149 self._log.info("END Launch")
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
150
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
151 if __name__ == "__main__":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
152 iLaunchTRF = LaunchTRF()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
153 iLaunchTRF.setAttributesFromCmdLine()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
154 iLaunchTRF.run()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
155