annotate commons/core/writer/WigWriter.py @ 14:c79b9ae3f65f

Deleted selected files
author m-zytnicki
date Fri, 19 Apr 2013 10:13:11 -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 from commons.core.writer.TranscriptListWriter import TranscriptListWriter
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
31
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
32
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
33 class WigWriter(TranscriptListWriter):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
34 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
35 A class that writes a transcript list into a file with WIGGLE format
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
36 @ivar fileName: name of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
37 @type fileName: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
38 @ivar handle: handle to the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
39 @type handle: file handle
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
40 @ivar header: first lines of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
41 @type header: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
42 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
43
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
44
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
45 def __init__(self, fileName, verbosity = 0):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
46 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
47 Constructor
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
48 @param fileName: name of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
49 @type fileName: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
50 @param verbosity: verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
51 @type verbosity: int
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
52 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
53 self.fileName = fileName
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54 self.verbosity = verbosity
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55 self.data = {-1: {}, 0: {}, 1: {}}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56 self.title = "Reads"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 self.strands = False
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 self.handle = None
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 def __del__(self):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63 Destructor
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64 Actually print the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 strand2string = {-1: "-", 1: "+", 0: ""}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 self.handle = open(self.fileName, "w")
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 self.handle.write("track type=wiggle_0 name=\"%s\"\n" % (self.title))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 for strand in self.data:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 for chromosome in sorted(self.data[strand]):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71 self.handle.write("variableStep chrom=%s%s\n" % (chromosome, strand2string[strand]))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72 for pos in sorted(self.data[strand][chromosome]):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 self.handle.write("%d\t%d\n" % (pos, self.data[strand][chromosome][pos]))
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 self.handle.close()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 @staticmethod
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 def getFileFormats():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 Get the format of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82 return ["wig", "wiggle"]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 @staticmethod
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 def getExtension():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 Get the usual extension for the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90 return "wig"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 def setTitle(self, title):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 Set the title of the track
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 @param title: the title of the track
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 @type title: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99 if title != None:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 self.title = title
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
103 def setStrands(self, strands):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
104 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
105 Consider each strand separately
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
106 @param boolean: whether each strand should be considered separately
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
107 @type boolean: boolean
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
108 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
109 self.strands = strands
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
110
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
111
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
112 def copyProperties(self, parser):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
113 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
114 Copy the properties collected by a parser, to produce a similar output
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
115 @param bedParser: a parser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
116 @type bedParser: class L{TranscriptListWriter<TranscriptListWriter>}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
117 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
118 self.setTitle(parser.title)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
119
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
120
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
121 def addTranscript(self, transcript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
122 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
123 Export the given transcript with GBrowse format
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
124 @param transcript: transcript to be printed
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
125 @type transcript: class L{Transcript<Transcript>}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
126 @return: a string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
127 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
128 chromosome = transcript.getChromosome()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
129 direction = transcript.getDirection()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
130 if not self.strands:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
131 direction = 0
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
132 if chromosome not in self.data[direction]:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
133 self.data[direction][chromosome] = {}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
134 for exon in transcript.getExons():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
135 for pos in range(exon.getStart(), exon.getEnd()+1):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
136 if pos not in self.data[direction][chromosome]:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
137 self.data[direction][chromosome][pos] = 1
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
138 else:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
139 self.data[direction][chromosome][pos] += 1