annotate uniqprimer-0.5.0/utils.py @ 2:05ae1ce478bc draft default tip

Uploaded
author dereeper
date Fri, 08 Jun 2018 10:49:07 -0400
parents cdd8f911ad91
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
1 '''
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
2 Created on Jan 1, 2011
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
3
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
4 @author: John L. Herndon
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
5 @contact: herndon@cs.colostate.edu
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
6 @organization: Colorado State University
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
7 @group: Computer Science Department, Asa Ben-Hur's laboratory
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
8 '''
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
9
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
10
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
11 import exceptions
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
12 import time
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
13 import os.path
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
14 from os import pathsep
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
15 from string import split
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
16 import tempfile
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
17 import shutil
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
18
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
19 def getTimeStamp( ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
20 return time.strftime('%d%m%Y-%H%M%S')
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
21
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
22
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
23 class Match( object ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
24 '''
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
25 record where two genomes line up. stores only alignments for one part of the genome
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
26 '''
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
27 def __init__( self, start, end, seqID ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
28 self.seqID = seqID
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
29 self.start = start
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
30 self.end = end
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
31
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
32 def __repr__( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
33 return "Start: {0}, End:{1}, SeqID:{2}".format( self.start, self.end, self.seqID )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
34
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
35 class PrimerSet( object ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
36
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
37 def __init__( self, id ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
38 self.id = id
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
39 self.productSize = 0
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
40 self.forwardPrimer = ""
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
41 self.forwardMeltTemp = ""
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
42 self.reversePrimer = ""
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
43 self.reverseMeltTemp = ""
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
44
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
45
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
46 def setProductSize( self, productSize):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
47 self.productSize = productSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
48
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
49 def setForwardPrimerData( self, sequence, temp ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
50 self.forwardPrimer = sequence
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
51 self.forwardMeltTemp = temp
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
52
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
53 def setReversePrimerData( self, sequence, temp):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
54 self.reversePrimer = sequence
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
55 self.reverseMeltTemp = temp
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
56
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
57
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
58 #search function from http://code.activestate.com/recipes/52224-find-a-file-given-a-search-path/
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
59 def search_file( filename ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
60 """ find file
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
61 """
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
62 search_path = os.getenv( 'PATH' )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
63 logMessage( "utils::search_file", "Path: {0}".format( search_path ) )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
64 file_found = 0
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
65 paths = split( search_path, pathsep )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
66 for path in paths:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
67 if os.path.exists( os.path.join( path, filename ) ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
68 file_found = 1
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
69 break
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
70 if file_found:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
71 return os.path.abspath( os.path.join( path, filename ) )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
72 else:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
73 return None
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
74
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
75 tempDir = ""
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
76 removeTemp = True
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
77
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
78 verbose = False
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
79
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
80
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
81 def initialize( isVerbose, cleanup, lf): ##Mau: added lf
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
82 global removeTemp
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
83 global tempDir
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
84 global verbose
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
85 global logFile ##Mau: added logFile variable
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
86
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
87 logFile = lf #:Mau add line
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
88
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
89 verbose = isVerbose
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
90 tempDir = tempfile.mkdtemp( dir="" )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
91 initializeLogging()
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
92 removeTemp = cleanup
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
93 logMessage( "utils::Initialize( )", "Initialization complete. Temporary directory: {0}".format( tempDir ) )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
94
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
95 logFile = None
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
96
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
97
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
98 def printProgressMessage( message ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
99 global verbose
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
100 if verbose == True:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
101 print message
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
102
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
103 def getTemporaryDirectory( ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
104 global tempDir
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
105 return tempDir
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
106
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
107 def initializeLogging():
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
108 global logFile
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
109 #logFileName = "uniqprimer_{0}.log".format( getTimeStamp( ) )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
110 #logFileName = "log_uniqprimer.txt" ##Mau: commented out
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
111 logFileName = logFile ##Mau: changed
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
112 logFile = open( logFileName, 'w' )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
113
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
114 def shutdown( ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
115 global removeTemp
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
116 global tempDir
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
117 shutdownLogging( )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
118 if removeTemp == True:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
119 print "*** Removing temporary directory ***"
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
120 shutil.rmtree( tempDir )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
121
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
122 def shutdownLogging( ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
123 global logFile
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
124 if logFile != None:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
125 logFile.close( )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
126
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
127 def logList( method, list ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
128
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
129 message = reduce( lambda x,y: str( x ) + " " + str( y ) , list )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
130 logMessage(method, message)
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
131
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
132
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
133 def logMessage( method, message ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
134 global logFile
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
135 if logFile == None:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
136 return
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
137 log = "{0} - {1}".format( method, message )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
138
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
139 logFile.write( log + "\n" )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
140 logFile.flush( )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
141
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
142 class EPrimerOptions( object ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
143
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
144 def __init__( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
145
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
146 self.minPrimerSize = 18
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
147 self.maxPrimerSize = 27
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
148 self.primerSize = 20
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
149 self.productRange = "200-250"
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
150
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
151 def setPrimerSize( self, size ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
152
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
153 size = int( size )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
154 if size > 35:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
155 size = 35
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
156
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
157 self.primerSize = size
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
158 if self.primerSize < self.minPrimerSize:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
159 self.maxPrimerSize = self.primerSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
160 elif self.primerSize > self.maxPrimerSize:
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
161 self.maxPrimerSize = self.primerSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
162
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
163 def getPrimerSize( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
164 return self.primerSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
165
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
166 def setMinPrimerSize( self, minSize):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
167 self.minPrimerSize = minSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
168
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
169 def getMinPrimerSize( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
170 return self.minPrimerSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
171
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
172 def setMaxPrimerSize( self, size ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
173 self.maxPrimerSize = size
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
174
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
175 def getMaxPrimerSize( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
176 return self.maxPrimerSize
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
177
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
178 def setProductRange( self, range ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
179 self.productRange = range
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
180
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
181 def getProductRange( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
182 return self.productRange
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
183
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
184 class NoPrimersExistException( exceptions.BaseException ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
185
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
186 def __init__( self ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
187 exceptions.BaseException( self )
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
188
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
189 class ProgramNotFoundException( exceptions.BaseException ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
190
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
191 def __init__( self, programName, details ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
192 exceptions.BaseException.__init__(self)
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
193 self.programName = programName
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
194 self.details = details
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
195
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
196 class NoFileFoundException( exceptions.BaseException ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
197
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
198 def __init__( self, filename ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
199 exceptions.BaseException.__init__(self)
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
200 self.filename = filename
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
201
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
202
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
203 class ModuleNotInitializedException( exceptions.BaseException ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
204
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
205 def __init__( self, moduleName, reason ):
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
206 self.moduleName = moduleName
cdd8f911ad91 Uploaded
dereeper
parents:
diff changeset
207 self.reason = reason