annotate commons/launcher/YassProgramLauncher.py @ 18:94ab73e8a190

Uploaded
author m-zytnicki
date Mon, 29 Apr 2013 03:20:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
1 #!/usr/bin/env python
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
2
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
3 ##@file
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
4 # Launch Yass (pairwise alignment).
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
5 #
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
6 # options:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
7 # -h: this help
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
8 # -i: name of the input file (queries, format='fasta')
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
9 # -s: name of the subject file (format='fasta')
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
10 # -p: parameters for 'yass' (default='-d 2')
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
11 # -o: name of the output file (format='align', default=inFile+'.align')
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
12 # -c: clean
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
13 # -v: verbosity level (default=0/1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
14
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
15
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
16 import os
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
17 import sys
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
18
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
19 from pyRepet.launcher.AbstractProgramLauncher import AbstractProgramLauncher
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
20
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
21
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
22 class YassProgramLauncher( AbstractProgramLauncher ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
23 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
24 Launch Yass (pairwise alignment).
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
25 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
26
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
27 def __init__( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
28 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
29 Constructor.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
30 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
31 AbstractProgramLauncher.__init__( self )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
32 self._prgName = "yass"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
33 self._formatInFile = "fasta"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
34 self._sbjFile = ""
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
35 self._prgParam = ""
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
36 self._allByAll = False
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
37 self._cmdLineSpecificOptions = "s:p:Ao:"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
38
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
39
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
40 def getSpecificHelpAsString( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
41 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
42 Return the specific help as a string.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
43 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
44 string = ""
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
45 string += "\nspecific options:"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
46 string += "\n -s: name of the subject file (format='fasta')"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
47 string += "\n -p: parameters for '%s'" % ( self.getProgramName() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
48 string += "\n -A: same sequences (all-by-all)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
49 string += "\n -o: name of the output file (format='align', default=inFile+'.align')"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
50 return string
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
51
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
52
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
53 def setASpecificAttributeFromCmdLine( self, o, a="" ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
54 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
55 Set a specific attribute from the command-line arguments.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
56 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
57 if o =="-s":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
58 self.setSubjectFile( a )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
59 elif o == "-p":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
60 self.setProgramParameters( a )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
61 elif o == "-A":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
62 self.setAllByAll()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
63 elif o == "-o":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
64 self.setOutputFile( a )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
65
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
66
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
67 def setSubjectFile( self, arg ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
68 self._sbjFile = arg
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
69
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
70
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
71 def getSubjectFile( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
72 return self._sbjFile
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
73
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
74
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
75 def setAllByAll( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
76 self._allByAll = True
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
77
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
78
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
79 def getAllByAll( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
80 return self._allByAll
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
81
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
82
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
83 def checkSpecificAttributes( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
84 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
85 Check the specific attributes before running the program.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
86 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
87 if self._sbjFile == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
88 string = "ERROR: missing subject file (-s)"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
89 print string
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
90 print self.getHelpAsString()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
91 sys.exit(1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
92 if self.getOutputFile() == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
93 self.setOutputFile( "%s.align" % ( self.getInputFile() ) )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
94
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
95
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
96 def setWrapperCommandLine( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
97 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
98 Set the command-line of the wrapper.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
99 Required for YassClusterLauncher.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
100 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
101 self._wrpCmdLine = self.getWrapperName()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
102 self._wrpCmdLine += " -i %s" % ( self.getInputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
103 self._wrpCmdLine += " -s %s" % ( self.getSubjectFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
104 if self.getProgramParameters() != "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
105 self._wrpCmdLine += " -p '%s'" % ( self.getProgramParameters() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
106 if self.getAllByAll():
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
107 self._wrpCmdLine += " -A"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
108 if self.getOutputFile() == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
109 self.setOutputFile( "%s.align" % ( self.getInputFile() ) )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
110 self._wrpCmdLine += " -o %s" % ( self.getOutputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
111 if self.getClean():
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
112 self._wrpCmdLine += " -c"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
113 self._wrpCmdLine += " -v %i" % ( self.getVerbosityLevel() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
114
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
115
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
116 def setProgramCommandLine( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
117 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
118 Set the command-line of the program.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
119 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
120 self._prgCmdLine = self.getProgramName()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
121 self._prgCmdLine += " -d 2"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
122 if self.getProgramParameters() != "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
123 self._prgCmdLine += " %s" % ( self.getProgramParameters() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
124 self._prgCmdLine += " -o %s.blast" % ( self.getInputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
125 self._prgCmdLine += " %s" % ( self.getInputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
126 self._prgCmdLine += " %s" % ( self.getSubjectFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
127
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
128
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
129 def setListFilesToKeep( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
130 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
131 Set the list of files to keep.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
132 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
133 if self.getOutputFile() == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
134 self.setOutputFile( "%s.align" % ( self.getInputFile() ) )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
135 self.appendFileToKeep( self.getOutputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
136
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
137
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
138 def setListFilesToRemove( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
139 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
140 Set the list of files to remove.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
141 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
142 pass
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
143
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
144
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
145 def convertBlastIntoAlign( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
146 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
147 Convert a 'blast' file into the 'align' format.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
148 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
149 cmd = os.environ["REPET_PATH"] + "/bin/blast2align.py"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
150 cmd += " -i %s.blast" % ( self.getInputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
151 cmd += " -o %s" % ( self.getOutputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
152 exitStatus = os.system( cmd )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
153 if exitStatus != 0:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
154 string = "ERROR while converting 'blast' file into 'align' format"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
155 print string
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
156 sys.exit(1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
157
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
158
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
159 def setSummary( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
160 self._summary = "input file: %s" % ( self.getInputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
161 self._summary += "\nsubject file: %s" % ( self.getSubjectFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
162 self._summary += "\nparameters: %s" % ( self.getProgramParameters() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
163 if self.getAllByAll():
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
164 self._summary += "\nall-by-all"
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
165 if self.getOutputFile() == "":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
166 self.setOutputFile( "%s.align" % ( self.getInputFile() ) )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
167 self._summary += "\noutput file: %s" % ( self.getOutputFile() )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
168
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
169
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
170 def run( self ):
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
171 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
172 Run the program.
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
173 """
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
174 self.start()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
175
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
176 self.setProgramCommandLine()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
177 cmd = self.getProgramCommandLine()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
178 if self.getVerbosityLevel() > 0:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
179 print "LAUNCH: %s" % ( cmd )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
180 sys.stdout.flush()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
181 exitStatus = os.system( cmd )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
182 if exitStatus != 0:
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
183 string = "ERROR: program '%s' returned exit status '%i'" % ( self.getProgramName(), exitStatus )
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
184 print string
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
185 sys.exit(1)
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
186
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
187 self.convertBlastIntoAlign()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
188
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
189 self.end()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
190
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
191
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
192 if __name__ == "__main__":
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
193 i = YassProgramLauncher()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
194 i.setAttributesFromCmdLine()
94ab73e8a190 Uploaded
m-zytnicki
parents:
diff changeset
195 i.run()