annotate commons/core/parsing/FastqParser.py @ 36:44d5973c188c

Uploaded
author m-zytnicki
date Tue, 30 Apr 2013 15:02:29 -0400
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 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
2 # Copyright INRA-URGI 2009-2010
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
3 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
4 # This software is governed by the CeCILL license under French law and
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
5 # abiding by the rules of distribution of free software. You can use,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
6 # modify and/ or redistribute the software under the terms of the CeCILL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
7 # license as circulated by CEA, CNRS and INRIA at the following URL
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
8 # "http://www.cecill.info".
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
9 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
10 # As a counterpart to the access to the source code and rights to copy,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
11 # modify and redistribute granted by the license, users are provided only
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
12 # with a limited warranty and the software's author, the holder of the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
13 # economic rights, and the successive licensors have only limited
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
14 # liability.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
15 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
16 # In this respect, the user's attention is drawn to the risks associated
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
17 # with loading, using, modifying and/or developing or reproducing the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
18 # software by the user in light of its specific status of free software,
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
19 # that may mean that it is complicated to manipulate, and that also
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
20 # therefore means that it is reserved for developers and experienced
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
21 # professionals having in-depth computer knowledge. Users are therefore
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
22 # encouraged to load and test the software's suitability as regards their
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
23 # requirements in conditions enabling the security of their systems and/or
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
24 # data to be ensured and, more generally, to use and operate it in the
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
25 # same conditions as regards security.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
26 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
27 # The fact that you are presently reading this means that you have had
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
28 # knowledge of the CeCILL license and that you accept its terms.
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
29 #
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
30 import sys
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
31 from commons.core.parsing.SequenceListParser import SequenceListParser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32 from SMART.Java.Python.structure.Sequence import Sequence
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 class FastqParser(SequenceListParser):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 """A class that reads a list of sequences in FASTQ format"""
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 def __init__(self, fileName, verbosity = 0):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 super(FastqParser, self).__init__(fileName, verbosity)
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 def getFileFormats():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 return ["fastq", "mfq"]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 getFileFormats = staticmethod(getFileFormats)
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 getInfos(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 Get some generic information about the sequences
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50 self.nbSequences = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 self.reset()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 if self.verbosity >= 10:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 print "Getting information on %s." % (self.fileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55 nbLines = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 for line in self.handle:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 line = line.strip()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 if line == "":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59 continue
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 nbLines += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 if self.verbosity >= 10 and nbLines % 400000 == 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 sys.stdout.write(" %d sequences read\r" % (nbLines / 4))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 sys.stdout.flush()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 self.reset()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65 self.nbSequences = nbLines / 4
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 if self.verbosity >= 10:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 print " %d sequences read" % (self.nbSequences)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 print "Done."
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 def parseOne(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 Parse only one element in the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 string = ""
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 quality = ""
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 lineType = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 for line in self.handle:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 line = line.strip()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 if lineType == 0:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 if line[0] != "@":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83 raise Exception("Line '%s' should start with '@'!" % (line))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 name = line[1:]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 inSequence = True
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 inQuality = False
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 elif lineType == 1:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 string = line
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 elif lineType == 2:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 if line[0] != "+":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91 sys.exit("Line '%s' should start with '+'!" % (line))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 if line[1:] != name and line != "+":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 sys.exit("Weird difference in sequence and quality names (%s and %s) while parsing FASTQ file %s." % (name, line[1:], self.fileName))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 inQuality = True
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 inSequence = False
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 elif lineType == 3:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 quality = line
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 lineType += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99 if lineType == 4:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 sequence = Sequence(name, string)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 sequence.setQuality(quality)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102 return sequence
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
103
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
104 return None