annotate SMART/Java/Python/getExons.py @ 69:1473ab954708 draft

Corrected bug in "CollapsedReads" XML file.
author m-zytnicki
date Wed, 18 Nov 2015 10:59:02 -0500
parents 769e306b7933
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 from optparse import OptionParser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32 from commons.core.parsing.ParserChooser import ParserChooser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 from commons.core.writer.TranscriptWriter import TranscriptWriter
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 from SMART.Java.Python.structure.Transcript import Transcript
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 from SMART.Java.Python.misc.Progress import Progress
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 zeroBaseToOneBaseConvertor = (lambda x: x - 1 if x > 0 else x)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39 class GetExons(object):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41 def __init__(self, verbosity):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 self.verbosity = verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 self.selection = False
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 def setInputFile(self, fileName, format):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 chooser = ParserChooser(self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 chooser.findFormat(format)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 self.parser = chooser.getParser(fileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50 def setSelection(self, selection):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 if selection == None:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 return
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 self.selection = True
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54 self.selectionItems = []
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55 self.selectionIntervals = []
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 for part in selection.split(","):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 try:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 splittedPart = map(int, part.split(".."))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59 except Exception:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 raise Exception("Elements '" + splittedPart + "' of selection '" + selection + "' do no seem to be integers!")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 if len(splittedPart) == 1:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 self.selectionItems.append(splittedPart[0])
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 elif len(splittedPart) == 2:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 self.selectionIntervals.append((splittedPart[0], splittedPart[1]))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 raise Exception("Cannot parse elements '" + splittedPart + "' of selection '" + selection + "'!")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 def getSelectionExonIndices(self, nbExons):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 if not self.selection:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 return range(nbExons)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 indices = []
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 for item in self.selectionItems:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 indices.append(range(nbExons)[zeroBaseToOneBaseConvertor(item)])
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 for start, end in self.selectionIntervals:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 start, end = map(zeroBaseToOneBaseConvertor, (start, end))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 if end > 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 end += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 indices.extend(range(nbExons)[start:end])
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 return indices
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 def setOutputFile(self, fileName):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 self.writer = TranscriptWriter(fileName, "gff3", self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 def run(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 progress = Progress(self.parser.getNbTranscripts(), "Reading input file", self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 nbExons = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 for cpt1, transcript in enumerate(self.parser.getIterator()):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 selectedExons = self.getSelectionExonIndices(transcript.getNbExons())
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 transcript.sortExons()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 for cpt2, exon in enumerate(transcript.getExons()):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91 if cpt2 not in selectedExons:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 continue
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 exonTranscript = Transcript()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 exonTranscript.copy(exon)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 if "Parent" in exonTranscript.tags:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 del exonTranscript.tags["Parent"]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 exonTranscript.tags["feature"] = "transcript"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 if "ID" not in exonTranscript.tags or exonTranscript.tags["ID"] == "unnamed transcript":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99 exonTranscript.tags["ID"] = "exon_%d-%d" % (cpt1+1, cpt2+1)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 if exonTranscript.getName() == "unnamed transcript":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 exonTranscript.setName("exon_%d-%d" % (cpt1+1, cpt2+1))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102 self.writer.addTranscript(exonTranscript)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
103 nbExons += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
104 progress.inc()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
105 self.writer.write()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
106 self.writer.close()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
107 progress.done()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
108 if self.verbosity > 1:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
109 print "%d transcripts read" % (self.parser.getNbTranscripts())
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
110 print "%d exons written" % (nbExons)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
111
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
112 if __name__ == "__main__":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
113
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
114 description = "Get Exons v1.0.1: Get the exons of a set of transcripts. [Category: Data Modification]"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
115
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
116 parser = OptionParser(description = description)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
117 parser.add_option("-i", "--input", dest="inputFileName", action="store", type="string", help="input file [compulsory] [format: file in transcript format given by -f]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
118 parser.add_option("-f", "--format", dest="format", action="store", type="string", help="format of file [compulsory] [format: transcript file format]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
119 parser.add_option("-s", "--select", dest="select", action="store", default=None, type="string", help="select some of the exons (like '1,2,5..-3,-1') [format: string]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
120 parser.add_option("-o", "--output", dest="outputFileName", action="store", type="string", help="output file [format: output file in GFF3 format]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
121 parser.add_option("-v", "--verbosity", dest="verbosity", action="store", default=1, type="int", help="trace level [format: int]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
122 (options, args) = parser.parse_args()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
123
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
124 ge = GetExons(options.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
125 ge.setInputFile(options.inputFileName, options.format)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
126 ge.setSelection(options.select)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
127 ge.setOutputFile(options.outputFileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
128 ge.run()