annotate SMART/Java/Python/CollapseReads.py @ 31:0ab839023fe4

Uploaded
author m-zytnicki
date Tue, 30 Apr 2013 14:33:21 -0400
parents 94ab73e8a190
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
1 #! /usr/bin/env python
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
2 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
3 # Copyright INRA-URGI 2009-2010
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
4 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
5 # This software is governed by the CeCILL license under French law and
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
6 # abiding by the rules of distribution of free software. You can use,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
7 # modify and/ or redistribute the software under the terms of the CeCILL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
8 # license as circulated by CEA, CNRS and INRIA at the following URL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
9 # "http://www.cecill.info".
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
10 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
11 # As a counterpart to the access to the source code and rights to copy,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
12 # modify and redistribute granted by the license, users are provided only
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
13 # with a limited warranty and the software's author, the holder of the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
14 # economic rights, and the successive licensors have only limited
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
15 # liability.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
16 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
17 # In this respect, the user's attention is drawn to the risks associated
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
18 # with loading, using, modifying and/or developing or reproducing the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
19 # software by the user in light of its specific status of free software,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
20 # that may mean that it is complicated to manipulate, and that also
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
21 # therefore means that it is reserved for developers and experienced
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
22 # professionals having in-depth computer knowledge. Users are therefore
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
23 # encouraged to load and test the software's suitability as regards their
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
24 # requirements in conditions enabling the security of their systems and/or
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
25 # data to be ensured and, more generally, to use and operate it in the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
26 # same conditions as regards security.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
27 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
28 # The fact that you are presently reading this means that you have had
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
29 # knowledge of the CeCILL license and that you accept its terms.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
30 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
31 import os
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32 from optparse import OptionParser, OptionGroup
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 from commons.core.parsing.ParserChooser import ParserChooser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 from commons.core.writer.Gff3Writer import Gff3Writer
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 from SMART.Java.Python.structure.Transcript import Transcript
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36 from SMART.Java.Python.ncList.NCListFilePickle import NCListFileUnpickle
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 from SMART.Java.Python.ncList.FileSorter import FileSorter
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 from SMART.Java.Python.misc.Progress import Progress
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41 class CollapseReads(object):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 Merge two reads if they have exactly the same genomic coordinates
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 def __init__(self, verbosity = 0):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 self.verbosity = verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 self.inputReader = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49 self.outputWriter = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50 self.strands = True
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 self.nbRead = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 self.nbWritten = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 self.nbMerges = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54 self.splittedFileNames = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 def __del__(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 for fileName in self.splittedFileNames.values():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 os.remove(fileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 def close(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 self.outputWriter.close()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 def setInputFile(self, fileName, format):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 parserChooser = ParserChooser(self.verbosity)
18
94ab73e8a190 Uploaded
m-zytnicki
parents: 6
diff changeset
65 parserChooser.findFormat(format)
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 self.parser = parserChooser.getParser(fileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 self.sortedFileName = "%s_sorted.pkl" % (os.path.splitext(fileName)[0])
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 def setOutputFile(self, fileName):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 self.outputWriter = Gff3Writer(fileName, self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 def getNbElements(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 return self.parser.getNbTranscripts()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 def _sortFile(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 fs = FileSorter(self.parser, self.verbosity-4)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 fs.perChromosome(True)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 fs.setOutputFileName(self.sortedFileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 fs.sort()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 self.splittedFileNames = fs.getOutputFileNames()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 self.nbElementsPerChromosome = fs.getNbElementsPerChromosome()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 self.nbRead = fs.getNbElements()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 def _iterate(self, chromosome):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 progress = Progress(self.nbElementsPerChromosome[chromosome], "Checking chromosome %s" % (chromosome), self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 transcripts = []
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 parser = NCListFileUnpickle(self.splittedFileNames[chromosome], self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 for newTranscript in parser.getIterator():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 newTranscripts = []
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 for oldTranscript in transcripts:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91 if self._checkOverlap(newTranscript, oldTranscript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 self._merge(newTranscript, oldTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 elif self._checkPassed(newTranscript, oldTranscript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 self._write(oldTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 newTranscripts.append(oldTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 newTranscripts.append(newTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 transcripts = newTranscripts
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99 progress.inc()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 for transcript in transcripts:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 self._write(transcript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102 progress.done()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
103
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
104 def _merge(self, transcript1, transcript2):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
105 self.nbMerges += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
106 transcript2.setDirection(transcript1.getDirection())
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
107 transcript1.merge(transcript2)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
108
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
109 def _write(self, transcript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
110 self.nbWritten += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
111 self.outputWriter.addTranscript(transcript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
112
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
113 def _checkOverlap(self, transcript1, transcript2):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
114 if transcript1.getStart() != transcript2.getStart() or transcript1.getEnd() != transcript2.getEnd():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
115 return False
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
116 return (not self.strands or transcript1.getDirection() == transcript2.getDirection())
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
117
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
118 def _checkPassed(self, transcript1, transcript2):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
119 return (transcript2.getStart() < transcript1.getStart())
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
120
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
121 def collapseChromosome(self, chromosome):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
122 progress = Progress(table.getNbElements(), "Analysing chromosome %s" % (chromosome), self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
123 command = "SELECT * FROM %s ORDER BY start ASC, end DESC" % (table.name)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
124 transcriptStart = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
125 transcriptEnd = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
126 transcriptDirection = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
127 currentTranscript = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
128 if self.strands:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
129 command += ", direction"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
130 for index, transcript in table.selectTranscripts(command, True):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
131 self.nbRead += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
132 if not self.strands:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
133 transcript.setDirection("+")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
134 if transcriptStart != transcript.getStart() or transcriptEnd != transcript.getEnd() or transcriptDirection != transcript.getDirection():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
135 self.writeTranscript(currentTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
136 transcriptStart = transcript.getStart()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
137 transcriptEnd = transcript.getEnd()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
138 transcriptDirection = transcript.getDirection()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
139 currentTranscript = transcript
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
140 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
141 currentTranscript.setTagValue("nbElements", (currentTranscript.getTagValue("nbElements") + 1) if "nbElements" in currentTranscript.getTagNames() else 1)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
142 progress.inc()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
143 self.writeTranscript(currentTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
144 progress.done()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
145
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
146 def collapse(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
147 self._sortFile()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
148 for chromosome in sorted(self.nbElementsPerChromosome.keys()):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
149 self._iterate(chromosome)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
150 self.outputWriter.close()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
151 if self.verbosity > 1:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
152 print "# reads read: %d" % (self.nbRead)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
153 print "# reads written: %d (%.2f%%)" % (self.nbWritten, float(self.nbWritten) / self.nbRead * 100)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
154 print "# reads merges: %d" % (self.nbMerges)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
155
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
156 if __name__ == "__main__":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
157
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
158 # parse command line
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
159 description = "Collapse Reads v1.0.3: Merge two reads if they have exactly the same genomic coordinates. [Category: Merge]"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
160
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
161 parser = OptionParser(description = description)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
162 parser.add_option("-i", "--input", dest="inputFileName", action="store", type="string", help="input file [compulsory] [format: file in mapping format given by -f]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
163 parser.add_option("-f", "--format", dest="format", action="store", type="string", help="format of the file [compulsory] [format: mapping file format]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
164 parser.add_option("-o", "--output", dest="outputFileName", action="store", type="string", help="output file [compulsory] [format: output file in GFF3 format]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
165 parser.add_option("-s", "--strands", dest="strands", action="store_true", default=False, help="merge elements on 2 different strands [format: bool] [default: false]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
166 parser.add_option("-v", "--verbosity", dest="verbosity", action="store", default=1, type="int", help="trace level [default: 1] [format: int]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
167 (options, args) = parser.parse_args()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
168
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
169 collapser = CollapseReads(options.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
170 collapser.setInputFile(options.inputFileName, options.format)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
171 collapser.setOutputFile(options.outputFileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
172 collapser.strands = not options.strands
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
173 collapser.collapse()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
174 collapser.close()