-
Notifications
You must be signed in to change notification settings - Fork 1
/
metaMLST_functions.py
481 lines (356 loc) · 15.4 KB
/
metaMLST_functions.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
#!/usr/bin/env python3
from __future__ import print_function
import json
import math
import sqlite3
import itertools
import subprocess
import time
import gc
import argparse
import re
import os
import sys
import pysam
from Bio import SeqIO
from Bio.Seq import Seq
from Bio.SeqRecord import SeqRecord
try:
from StringIO import StringIO
except ImportError:
from io import StringIO
__author__ = 'Moreno Zolfo ([email protected])'
__version__ = '1.2.3'
__date__ = '27 May 2022'
def byte_to_megabyte(byte):
"""
Convert byte value to megabyte
"""
return byte / (1024.0**2)
def check_install():
import zipfile,os
METAMLST_DBPATH=os.path.abspath(os.path.dirname(__file__))+'/metamlst_databases/metamlstDB_2022.db'
METAMLST_DBFOLDER=os.path.abspath(os.path.dirname(__file__))+'/metamlst_databases/'
METAMLST_URL='https://zenodo.org/record/6586741/files/metamlstDB_2022.db.zip?download=1'
if not os.path.isdir(METAMLST_DBFOLDER):
os.mkdir(METAMLST_DBFOLDER,mode=0o775)
if not os.path.isfile(METAMLST_DBPATH):
download(METAMLST_URL, METAMLST_DBPATH+'.zip')
if os.path.isfile(METAMLST_DBPATH+'.zip'):
zip_ref = zipfile.ZipFile(METAMLST_DBPATH+'.zip', 'r')
zip_ref.extractall(METAMLST_DBFOLDER)
zip_ref.close()
if os.path.isfile(METAMLST_DBPATH):
return METAMLST_DBPATH
class ReportHook():
def __init__(self):
self.start_time = time.time()
def report(self, blocknum, block_size, total_size):
"""
Print download progress message
"""
if blocknum == 0:
self.start_time = time.time()
if total_size > 0:
sys.stderr.write("Downloading file of size: {:.2f} MB\n"
.format(byte_to_megabyte(total_size)))
else:
total_downloaded = blocknum * block_size
status = "{:3.2f} MB ".format(byte_to_megabyte(total_downloaded))
if total_size > 0:
percent_downloaded = total_downloaded * 100.0 / total_size
# use carriage return plus sys.stderr to overwrite stderr
download_rate = total_downloaded / (time.time() - self.start_time)
estimated_time = (total_size - total_downloaded) / download_rate
estimated_minutes = int(estimated_time / 60.0)
estimated_seconds = estimated_time - estimated_minutes * 60.0
status += ("{:3.2f} % {:5.2f} MB/sec {:2.0f} min {:2.0f} sec "
.format(percent_downloaded,
byte_to_megabyte(download_rate),
estimated_minutes, estimated_seconds))
status += " \r"
sys.stderr.write(status)
def download(url, download_file):
"""
Download a file from a url
"""
# try to import urllib.request.urlretrieve for python3
try:
from urllib.request import urlretrieve
except ImportError:
from urllib import urlretrieve
if not os.path.isfile(download_file):
try:
sys.stderr.write("\nDownloading " + url + " to "+download_file+"\n")
file, headers = urlretrieve(url, download_file,
reporthook=ReportHook().report)
except EnvironmentError:
sys.stderr.write("\nWarning: Unable to download " + url + "\n")
else:
sys.stderr.write("\nFile {} already present!\n".format(download_file))
def print_version():
print ("Version:\t"+__version__)
print ("Author:\t\t"+__author__)
print ("Reference:\t"+'MetaMLST: multi-locus strain-level bacterial typing from metagenomic samples\n\t\tNucleic Acids Research, 2016\n\t\tDOI: 10.1093/nar/gkw837')
sys.exit(0)
def metamlst_print(mesg,label,type,reline=False,newLine=False):
opening = "\r" if reline else ''
ending = "\r\n" if not reline or newLine else ''
if len(mesg) < 65:
sys.stdout.write(opening+mesg.ljust(66)+(type+'[ - '+label.center(5)+' - ]'+bcolors.ENDC).ljust(14)+ending)
else:
c=0
wds = []
lines=[]
for word in mesg.split(' '):
if c + len(word)+2 > 65:
print (' '.join(wds))
c=0
wds=[word]
continue
c = c+len(word)+2
wds.append(word)
sys.stdout.write(opening+(' '.join(wds)).ljust(66)+(type+'[ - '+label.center(5)+' - ]'+bcolors.ENDC).ljust(14)+ending)
sys.stdout.flush()
def metamlst_newline():
sys.stdout.write('\r\n')
def dump_db_to_fasta(conn,path,filterb=None):
conn.row_factory = sqlite3.Row
cursor = conn.cursor()
#print ' COLLECTING DATA'.ljust(60),
metamlst_print("COLLECTING DATA...",'...',bcolors.ENDC)
sys.stdout.flush()
if filterb is None: strr=[SeqRecord(Seq(row['sequence']),id=row['bacterium']+'_'+(row['gene']+'_'+str(row['alleleVariant'])),description='') for row in cursor.execute("SELECT bacterium,gene,alleleVariant,sequence FROM alleles WHERE sequence <> ''")]
else: strr=[SeqRecord(Seq(row['sequence']),id=row['bacterium']+'_'+(row['gene']+'_'+str(row['alleleVariant'])),description='') for row in cursor.execute("SELECT bacterium,gene,alleleVariant,sequence FROM alleles WHERE sequence <> '' AND bacterium = ?",(filterb,))]
SeqIO.write(strr,path,'fasta')
return len(strr)
def alleleInProfile(conn,bacterium,gene,allele,profile):
e = conn.cursor()
e.execute("SELECT 1 FROM profiles,alleles WHERE alleleCode = alleles.recID AND profileCode = ? AND alleleVariant = ? AND gene = ? AND profiles.bacterium = ?",(profile,allele,gene,bacterium))
return (len(e.fetchall()) > 0)
def sequenceExists(conn,bacterium,sequence):
e = conn.cursor()
e.execute("SELECT 1 FROM alleles WHERE sequence = ? AND bacterium = ?",(str(sequence),bacterium))
return (len(e.fetchall()) > 0)
def alleleInManyProfile(conn,bacterium,gene,allele,profileList):
e = conn.cursor()
profileString = ','.join([str(x) for x in profileList])
e.execute("SELECT 1 FROM profiles,alleles WHERE alleleCode = alleles.recID AND profileCode IN ("+profileString+") AND alleleVariant = ? AND gene = ? AND profiles.bacterium = ?",(allele,gene,bacterium))
return (len(e.fetchall()) > 0)
def db_getSequence(conn,bacterium,gene,allele):
e = conn.cursor()
e.execute("SELECT alignedSequence FROM alleles WHERE bacterium = ? AND gene = ? AND alleleVariant = ?",(bacterium,gene,allele))
return (e.fetchone()['alignedSequence'])
def db_getUnalSequence(conn,bacterium,gene,allele):
e = conn.cursor()
unal = e.execute("SELECT sequence FROM alleles WHERE bacterium = ? AND gene = ? AND alleleVariant = ?",(bacterium,gene,allele))
unalobj = unal.fetchone()
if unalobj is not None:
return unalobj['sequence']
else:
metamlst_print(' > '+bacterium+'_'+gene+'_'+allele+" was not found in the database!",'!!!',bcolors.WARNING)
return None
def sequenceFind(conn,bacterium,sequence):
e = conn.cursor()
e.execute("SELECT gene,alleleVariant FROM alleles WHERE sequence = ? AND bacterium = ?",(str(sequence),bacterium))
res = e.fetchone()
if res: return res['gene']
else: return 0
def defineProfile(conn,geneList):
recs=[]
for allele in geneList:
e = conn.cursor()
e.execute("SELECT recID FROM alleles WHERE bacterium||'_'||gene||'_'||alleleVariant = ?",(allele,))
result = e.fetchone()
if result:
recs.append(str(result['recID']))
return [(row['profileCode'],int((float(row['T'])/float(len(recs)))*100)) for row in e.execute("SELECT profileCode, COUNT(*) as T FROM profiles WHERE alleleCode IN ("+','.join(recs)+") GROUP BY profileCode HAVING T = (SELECT COUNT(*) FROM profiles WHERE alleleCode IN ("+','.join(recs)+") GROUP BY profileCode ORDER BY COUNT(*) DESC LIMIT 1) ORDER BY T DESC")] if result else [(0,0)]
def sequenceLocate(conn,bacterium,sequence):
e = conn.cursor()
e.execute("SELECT alleleVariant FROM alleles WHERE sequence = ? AND bacterium = ?",(str(sequence),bacterium))
return str(e.fetchone()['alleleVariant'])
def sequencesGetAll(conn,bacterium,gene):
e = conn.cursor()
e.execute("SELECT sequence,alleleVariant FROM alleles WHERE gene = ? AND bacterium = ?",(gene,bacterium))
return dict((x['alleleVariant'],x['sequence']) for x in e.fetchall())
def stringDiff(s1,s2):
c =0
for a,b in zip(s1,s2):
if a!=b: c+=1
return c
def sort_index(bamFile,legacy=False):
if legacy:
subprocess.call(['samtools','sort',bamFile,bamFile+'.s'])
os.rename(bamFile+'.s.bam',bamFile)
else:
subprocess.call(['samtools','sort',bamFile,'-o',bamFile+'.sorted'])
os.rename(bamFile+'.sorted',bamFile)
subprocess.call(['samtools','index',bamFile])
def buildConsensus(bamFile,chromosomeList,filterScore,max_xM,debugMode,legacy=False):
# imports
from cmseq import cmseq
seqRec = []
referenceLoci = list(chromosomeList.keys())
vf = cmseq.BamFile(bamFile,filterInputList=referenceLoci)
for chromo,nucleots in chromosomeList.items():
rSequen = list(vf.get_contig_by_label(chromo).reference_free_consensus(dominant_frq_thrsh=0.4, mincov=1, minqual=20, noneCharacter='N',
BAM_tagFilter=[('AS', 'loc_gte', filterScore), ('XM', 'loc_lte', max_xM)]))
dbSequen = chromosomeList[chromo]
i = 0
cIndex = 0
SNPs = 0
for chr in rSequen:
if chr == 'N':
rSequen[i] = dbSequen[i].lower()
cIndex += 1
elif rSequen[i] != dbSequen[i]:
rSequen[i] = rSequen[i]
SNPs += 1
i+=1
sequen = ''.join(rSequen)
seqRec.append(SeqRecord(Seq(sequen),id=chromo, description = 'CI::'+str(cIndex)+'_SP::'+str(SNPs)))
print ('\r', end='')
vf.bam_handle.close()
return seqRec
def buildConsensus_legacy(bamFile,chromosomeList,filterScore,max_xM,debugMode,legacy_samtools=False):
chromosomes = {}
chromosomesLen = {}
metamlst_print('Pysam not detected: using legacy mode','...',bcolors.HEADER)
strr=''
filterSpec = chromosomeList.keys()[0].split('_')[0].strip()
fili = open(bamFile,'r') if os.path.isfile(bamFile) else sys.stdin
devnull = open('/dev/null', 'w')
child = subprocess.Popen("samtools view -h - | grep "+filterSpec,shell=True, stdout=subprocess.PIPE, stdin = fili)
for line in child.stdout:
pox = 0
line = line.strip()
if line=='': continue
for chromoKey in chromosomeList.keys():
if (line.startswith('@SQ') and line.split('\t')[1].split(':')[1].strip() == chromoKey) or (not line.startswith('@') and line.split('\t')[2] == chromoKey):
pox = 1
break
if not pox:
continue
if line.startswith("@SQ"): #chromosomes data
chromosomesLen[line.split('\t')[1].replace('SN:','')] = int(line.split('\t')[2].replace('LN:',''))
strr+=line+'\r\n'
elif line.startswith("@"): strr+=line+'\r\n' #other data
else: #align data
tline = line.split('\t')
scoreOfRead = (int)((tline[11]).split(':')[2])
xM = (int)((tline[14]).split(':')[2])
if scoreOfRead >= filterScore and xM <= max_xM:
tline[1] = str(int(tline[1]) & 0b1111011111111)
strr+='\t'.join(tline)+'\r\n'
devnull = open('/dev/null', 'w')
if legacy_samtools: child = subprocess.Popen("samtools view -bS - | samtools sort -o - - | samtools mpileup - ",shell=True, stdout=subprocess.PIPE, stdin = subprocess.PIPE,stderr = devnull)
else: child = subprocess.Popen("samtools view -bS - | samtools sort -o - - | samtools mpileup - ",shell=True, stdout=subprocess.PIPE, stdin = subprocess.PIPE,stderr = devnull)
out = StringIO(child.communicate(strr)[0])
if debugMode: print (out.getvalue())
for line in out:
chromosome = line.split('\t')[0]
nucleotide = int(line.split('\t')[1])
if line.split('\t')[4] == '': continue
escape = 0
escapeLen = 0
if chromosome not in chromosomes: chromosomes[chromosome] = {}
ldict = {'A':0, 'T':0, 'C':0,'G':0}
for chr in line.split('\t')[4]:
if chr == '+' or chr == '-':
escape = 1
continue
if escape:
if chr.isdigit():
escapeLen = int(chr)+1
escape = 0
if escapeLen > 0:
escapeLen -=1
continue
elif chr.upper() in ldict:
ldict[chr.upper()] += 1
chromosomes[chromosome][nucleotide] = max(ldict, key=ldict.get)
del out
seqRec=[]
for chromo,nucleots in chromosomes.items():
sys.stdout.flush()
sequen = ""
lastSet = 0
for key,nucleotide in sorted(nucleots.items(), key=lambda x : x[0]):
if lastSet+1 != key:
sequen = sequen + "N" * (key-(lastSet+1))
lastSet = key
sequen = sequen + nucleotide
sequen+=((chromosomesLen[chromo]-len(sequen))*"N")
rSequen = list(sequen)
dbSequen = chromosomeList[chromo]
i=0
cIndex=0
SNPs=0
for chr in rSequen:
if chr == 'N':
rSequen[i] = dbSequen[i].lower()
cIndex+=1
elif rSequen[i] != dbSequen[i]:
rSequen[i] = rSequen[i]
SNPs+=1
i+=1
sequen = ''.join(rSequen)
seqRec.append(SeqRecord(Seq(sequen),id=chromo, description = 'CI::'+str(cIndex)+'_SP::'+str(SNPs)))
print ('\r', end='')
return seqRec
MLST_KEYWORDS = ['clonal_complex','species','mlst_clade']
class bcolors:
HEADER = '\033[95m'
OKBLUE = '\033[94m'
OKGREEN = '\033[92m'
WARNING = '\033[93m'
FAIL = '\033[91m'
ENDC = '\033[0m'
OKGREEN2 = '\033[42m\033[30m'
RED = '\033[1;91m'
CYAN = '\033[0;37m'
def db_getOrganisms(conn,bacterium=None):
e = conn.cursor()
t= dict((elem['organismkey'],( (elem['label']) if elem['label'] is not None else '('+elem['organismkey']+')')) for elem in e.execute("SELECT label,organismkey,COUNT(DISTINCT profileCode) AS totalProfiles FROM organisms,profiles WHERE organismkey = bacterium GROUP BY label,organismkey"))
if bacterium: return t[bacterium]
else: return t
class metaMLST_db:
cursor = None
conn = None
def __init__(self,dbPath):
try:
self.conn = sqlite3.connect(dbPath)
self.conn.row_factory = sqlite3.Row
self.cursor = self.conn.cursor()
except IOError:
print ("IOError: unable to access database "+dbPath)
def closeConnection(self):
self.conn.close()
def getOrganisms(self,bacterium=None):
listAlleles = []
t= dict((elem['organismkey'],(elem['label']) if elem['label'] is not None else '('+elem['organismkey']+')') for elem in self.cursor.execute("SELECT * FROM organisms"))
if bacterium: return t[bacterium]
else: return t
def getAlleles(self,profile):
listAlleles = []
for row in self.cursor.execute("SELECT bacterium,gene,alleleVariant,sequence FROM alleles WHERE sequence <> '' AND bacterium = ?",(profile,)):
listAlleles.append(SeqRecord(Seq(row['sequence']),id=row['bacterium']+'_'+(row['gene']+'_'+str(row['alleleVariant'])),description=''))
return listAlleles
def getGene(self,profile,geneName):
listAlleles = []
for row in self.cursor.execute("SELECT bacterium,gene,alleleVariant,sequence FROM alleles WHERE sequence <> '' AND bacterium = ? AND gene = ?",(profile,geneName)):
listAlleles.append(SeqRecord(Seq(row['sequence']),id=row['bacterium']+'_'+(row['gene']+'_'+str(row['alleleVariant'])),description=''))
return listAlleles
def getGeneNames(self,profile):
lister = []
for row in self.cursor.execute("SELECT geneName FROM genes WHERE bacterium = ?",(profile,)):
lister.append(row['geneName'])
return lister
def defineProfile(self,geneList):
recs=[]
result = None
for allele in geneList:
self.cursor.execute("SELECT recID FROM alleles WHERE bacterium||'_'||gene||'_'||alleleVariant = ?",(allele,))
result = self.cursor.fetchone()
if result: recs.append(str(result['recID']))
return [(row['profileCode'],int((float(row['T'])/float(len(recs)))*100)) for row in self.cursor.execute("SELECT profileCode, COUNT(*) as T FROM profiles WHERE alleleCode IN ("+','.join(recs)+") GROUP BY profileCode HAVING T = (SELECT COUNT(*) FROM profiles WHERE alleleCode IN ("+','.join(recs)+") GROUP BY profileCode ORDER BY COUNT(*) DESC LIMIT 1) ORDER BY T DESC")] if result else [(0,0)]