annotate commons/core/writer/GbWriter.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 GbWriter(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 GBrowse 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.header = "[READS]\nbgcolor = red\nstrand_arrow = 1\n\n"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
54 super(GbWriter, self).__init__(fileName, verbosity)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
55
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
56
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
57 @staticmethod
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
58 def getFileFormats():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
59 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
60 Get the format of the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
61 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
62 return ["gb", "gbrowse"]
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
63
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
64
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
65 @staticmethod
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
66 def getExtension():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
67 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
68 Get the usual extension for the file
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
69 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
70 return "gb"
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
71
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
72
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
73 def setColor(self, color):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
74 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
75 Set the color of the track
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
76 @param color: the color of the track
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
77 @type color: string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
78 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
79 if color != None:
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
80 self.header = "[READS]\nbgcolor= %s\nstrand_arrow = 1\n\n" % (color)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
81
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
82
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
83 def copyProperties(self, gbParser):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
84 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
85 Copy the properties collected by a parser, to produce a similar output
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
86 @param gbParser: a GBrowse parser
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
87 @type gbParser: class L{GbParser<GbParser>}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
88 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
89 self.setColor(gbParser.color)
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
90
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
91
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
92 def printTranscript(self, transcript):
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
93 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
94 Export the given transcript with GBrowse format
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
95 Possibly skip the reference if already put
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
96 @param transcript: transcript to be printed
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
97 @type transcript: class L{Transcript<Transcript>}
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
98 @return: a string
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
99 """
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
100 if self.lastChromosome != None and self.lastChromosome == transcript.getChromosome():
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
101 return transcript.printGBrowseLine()
769e306b7933 Change the repository level.
yufei-luo
parents:
diff changeset
102 return transcript.printGBrowse()