annotate SMART/Java/Python/cleanGff.py @ 47:b6481845eb0d

Uploaded
author m-zytnicki
date Mon, 30 Sep 2013 05:51:28 -0400
parents 169d364ddd91
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 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32 Clean a GFF file (as given by NCBI or TAIR) and outputs a GFF3 file.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 import os
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36 import re
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 from optparse import OptionParser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 from commons.core.parsing.GffParser import *
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39 from SMART.Java.Python.misc.RPlotter import *
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40 from SMART.Java.Python.misc.Progress import Progress
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41 from SMART.Java.Python.misc.UnlimitedProgress import UnlimitedProgress
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 count = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 class ParsedLine(object):
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
46 def __init__(self, line, cpt):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
47 self.line = line
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
48 self.cpt = cpt
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
49 self.parse()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
51 def parse(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
52 self.line = self.line.strip()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
53 self.splittedLine = self.line.split(None, 8)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
54 if len(self.splittedLine) < 9:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
55 raise Exception("Line '%s' has less than 9 fields. Exiting..." % (self.line))
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
56 self.type = self.splittedLine[2]
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
57 self.parseOptions()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
58 self.getId()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
59 self.getParents()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
61 def parseOptions(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
62 self.parsedOptions = {}
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
63 for option in self.splittedLine[8].split(";"):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
64 option = option.strip()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
65 if option == "": continue
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
66 posSpace = option.find(" ")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
67 posEqual = option.find("=")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
68 if posEqual != -1 and (posEqual < posSpace or posSpace == -1):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
69 key, value = option.split("=", 1)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
70 elif posSpace != -1:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
71 key, value = option.split(None, 1)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
72 else:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
73 key = "ID"
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
74 value = option
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
75 self.parsedOptions[key.strip()] = value.strip(" \"")
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
77 def getId(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
78 for key in self.parsedOptions:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
79 if key.lower() == "id":
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
80 self.id = self.parsedOptions[key]
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
81 return
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
82 if "Parent" in self.parsedOptions:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
83 parent = self.parsedOptions["Parent"].split(",")[0]
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
84 if parent not in count:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
85 count[parent] = {}
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
86 if self.type not in count[parent]:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
87 count[parent][self.type] = 0
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
88 count[parent][self.type] += 1
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
89 self.id = "%s-%s-%d" % (parent, self.type, count[parent][self.type])
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
90 else:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
91 self.id = "smart%d" % (self.cpt)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
92 self.parsedOptions["ID"] = self.id
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
94 def getParents(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
95 for key in self.parsedOptions:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
96 if key.lower() in ("parent", "derives_from"):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
97 self.parents = self.parsedOptions[key].split(",")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
98 return
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
99 self.parents = None
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
101 def removeParent(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
102 for key in self.parsedOptions.keys():
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
103 if key.lower() in ("parent", "derives_from"):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
104 del self.parsedOptions[key]
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
105
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
106 def export(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
107 self.splittedLine[8] = ";".join(["%s=%s" % (key, value) for key, value in self.parsedOptions.iteritems()])
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
108 return "%s\n" % ("\t".join(self.splittedLine))
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
109
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
110
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
111 class CleanGff(object):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
112
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
113 def __init__(self, verbosity = 1):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
114 self.verbosity = verbosity
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
115 self.lines = {}
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
116 self.acceptedTypes = []
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
117 self.parents = []
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
118 self.children = {}
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
119
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
120 def setInputFileName(self, name):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
121 self.inputFile = open(name)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
122
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
123 def setOutputFileName(self, name):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
124 self.outputFile = open(name, "w")
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
125
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
126 def setAcceptedTypes(self, types):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
127 self.acceptedTypes = types
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
128
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
129 def parse(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
130 progress = UnlimitedProgress(100000, "Reading input file", self.verbosity)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
131 for cpt, line in enumerate(self.inputFile):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
132 if not line or line[0] == "#": continue
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
133 if line[0] == ">": break
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
134 parsedLine = ParsedLine(line, cpt)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
135 if parsedLine.type in self.acceptedTypes:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
136 self.lines[parsedLine.id] = parsedLine
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
137 progress.inc()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
138 progress.done()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
139
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
140 def sort(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
141 progress = Progress(len(self.lines.keys()), "Sorting file", self.verbosity)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
142 for line in self.lines.values():
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
143 parentFound = False
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
144 if line.parents:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
145 for parent in line.parents:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
146 if parent in self.lines:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
147 parentFound = True
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
148 if parent in self.children:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
149 self.children[parent].append(line)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
150 else:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
151 self.children[parent] = [line]
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
152 if not parentFound:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
153 line.removeParent()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
154 self.parents.append(line)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
155 progress.inc()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
156 progress.done()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
157
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
158 def write(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
159 progress = Progress(len(self.parents), "Writing output file", self.verbosity)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
160 for line in self.parents:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
161 self.writeLine(line)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
162 progress.inc()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
163 self.outputFile.close()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
164 progress.done()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
165
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
166 def writeLine(self, line):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
167 self.outputFile.write(line.export())
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
168 if line.id in self.children:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
169 for child in self.children[line.id]:
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
170 self.writeLine(child)
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
171
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
172 def run(self):
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
173 self.parse()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
174 self.sort()
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
175 self.write()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
176
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
177
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
178 if __name__ == "__main__":
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
179
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
180 # parse command line
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
181 description = "Clean GFF v1.0.3: Clean a GFF file (as given by NCBI) and outputs a GFF3 file. [Category: Other]"
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
182
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
183 parser = OptionParser(description = description)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
184 parser.add_option("-i", "--input", dest="inputFileName", action="store", type="string", help="input file name [compulsory] [format: file in GFF format]")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
185 parser.add_option("-o", "--output", dest="outputFileName", action="store", type="string", help="output file [compulsory] [format: output file in GFF3 format]")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
186 parser.add_option("-t", "--types", dest="types", action="store", default="mRNA,exon", type="string", help="list of comma-separated types that you want to keep [format: string] [default: mRNA,exon]")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
187 parser.add_option("-v", "--verbosity", dest="verbosity", action="store", default=1, type="int", help="trace level [format: int]")
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
188 (options, args) = parser.parse_args()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
189
46
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
190 cleanGff = CleanGff(options.verbosity)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
191 cleanGff.setInputFileName(options.inputFileName)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
192 cleanGff.setOutputFileName(options.outputFileName)
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
193 cleanGff.setAcceptedTypes(options.types.split(","))
169d364ddd91 Uploaded
m-zytnicki
parents: 40
diff changeset
194 cleanGff.run()
6
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
195