annotate SMART/Java/Python/plotGenomeCoverage.py @ 6:769e306b7933

Change the repository level.
author yufei-luo
date Fri, 18 Jan 2013 04:54:14 -0500
parents
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 from optparse import OptionParser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 from commons.core.parsing.FastaParser import FastaParser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 from SMART.Java.Python.structure.TranscriptContainer import TranscriptContainer
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 from SMART.Java.Python.misc.RPlotter import RPlotter
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 from SMART.Java.Python.misc.Utils import *
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40 class GetGenomeCoverage(object):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 def __init__(self, verbosity = 1):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43 self.verbosity = verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44 self.inputContainer = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 self.referenceParser = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 self.outputFileName = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 self.genomeSize = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 self.coverage = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49 self.distribution = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 def setInputFile(self, fileName, format):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 self.inputContainer = TranscriptContainer(fileName, format, self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 def setOutputFile(self, fileName):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 self.outputFileName = fileName
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 def setReference(self, fileName):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 self.referenceParser = FastaParser(fileName, self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 def getReferenceSizes(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65 self.genomeSize = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 for chromosome in self.referenceParser.getRegions():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 self.genomeSize += self.referenceParser.getSizeOfRegion(chromosome)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 def getCoverage(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 progress = Progress(self.inputContainer.getNbTranscripts(), "Reading reads", self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 for transcript in self.inputContainer.getIterator():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 chromosome = transcript.getChromosome()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 if chromosome not in self.coverage:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 self.coverage[chromosome] = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 for exon in transcript.getExons():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 for pos in range(exon.getStart(), exon.getEnd() + 1):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 if pos not in self.coverage[chromosome]:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 self.coverage[chromosome][pos] = 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 self.coverage[chromosome][pos] += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 progress.inc()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83 progress.done()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 def getDistribution(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 nbNucleotides = sum([len(self.coverage[chromosome].keys()) for chromosome in self.coverage])
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 progress = Progress(nbNucleotides, "Building distribution", self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 for chromosome in self.coverage:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 for num in self.coverage[chromosome].values():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91 if num not in self.distribution:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 self.distribution[num] = 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 self.distribution[num] += 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 progress.inc()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 progress.done()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 self.distribution[0] = self.genomeSize - nbNucleotides
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 def plotDistribution(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 plotter = RPlotter(self.outputFileName, self.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102 plotter.setFill(0)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
103 plotter.addLine(self.distribution)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
104 plotter.plot()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
105 print "min/avg/med/max reads per base: %d/%.2f/%.1f/%d" % getMinAvgMedMax(self.distribution)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
106
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
107
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
108 def run(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
109 self.getReferenceSizes()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
110 self.getCoverage()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
111 self.getDistribution()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
112 self.plotDistribution()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
113
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
114
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
115 if __name__ == "__main__":
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
116
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
117 # parse command line
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
118 description = "Plot Genome Coverage v1.0.1: Get the coverage of a genome. [Category: Personal]"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
119
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
120 parser = OptionParser(description = description)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
121 parser.add_option("-i", "--input", dest="inputFileName", action="store", type="string", help="reads file [compulsory] [format: file in transcript format given by -f]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
122 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
123 parser.add_option("-r", "--reference", dest="reference", action="store", type="string", help="sequences file [compulsory] [format: file in FASTA format]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
124 parser.add_option("-o", "--output", dest="outputFileName", action="store", type="string", help="output file [compulsory] [format: output file in PNG format]")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
125 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
126 (options, args) = parser.parse_args()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
127
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
128 getGenomeCoverage = GetGenomeCoverage(options.verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
129 getGenomeCoverage.setInputFile(options.inputFileName, options.format)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
130 getGenomeCoverage.setOutputFile(options.outputFileName)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
131 getGenomeCoverage.setReference(options.reference)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
132 getGenomeCoverage.run()