-
Notifications
You must be signed in to change notification settings - Fork 73
/
main.py
executable file
·1038 lines (808 loc) · 41.1 KB
/
main.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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
###############################################################################
# #
# This program is free software: you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by #
# the Free Software Foundation, either version 3 of the License, or #
# (at your option) any later version. #
# #
# This program is distributed in the hope that it will be useful, #
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
# GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License #
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
# #
###############################################################################
import os
import sys
import logging
from checkm.defaultValues import DefaultValues
from checkm.timeKeeper import TimeKeeper
from checkm.markerSets import MarkerSetParser, BinMarkerSets
from checkm.resultsParser import ResultsParser
from checkm.hmmerAligner import HmmerAligner
from checkm.markerGeneFinder import MarkerGeneFinder
from checkm.pplacer import PplacerRunner
from checkm.treeParser import TreeParser
from checkm.taxonParser import TaxonParser
from checkm.aminoAcidIdentity import AminoAcidIdentity
from checkm.binStatistics import BinStatistics
from checkm.coverage import Coverage
from checkm.coverageWindows import CoverageWindows
from checkm.genomicSignatures import GenomicSignatures
from checkm.unbinned import Unbinned
from checkm.merger import Merger
from checkm.profile import Profile
from checkm.binTools import BinTools
from checkm.ssuFinder import SSU_Finder
from checkm.common import (checkBinInputExists,
makeSurePathExists,
checkFileExists,
binIdFromFilename,
getBinIdsFromOutDir,
checkDirExists)
from checkm.plot.gcPlots import GcPlots
from checkm.plot.codingDensityPlots import CodingDensityPlots
from checkm.plot.tetraDistPlots import TetraDistPlots
from checkm.plot.distributionPlots import DistributionPlots
from checkm.plot.nxPlot import NxPlot
from checkm.plot.lengthHistogram import LengthHistogram
from checkm.plot.markerGenePosPlot import MarkerGenePosPlot
from checkm.plot.gcBiasPlots import GcBiasPlot
from checkm.util.seqUtils import checkNuclotideSeqs, checkProteinSeqs
from checkm.checkmData import DBManager
from checkm.test.test_ecoli import VerifyEcoli
class OptionsParser():
def __init__(self):
self.logger = logging.getLogger('timestamp')
self.timeKeeper = TimeKeeper()
def updateCheckM_DB(self, options):
self.logger.info(
'[CheckM - data] Check for database updates. [%s]' % options.action[0])
action = options.action
if action and action[0] == 'setRoot':
if len(action) > 2:
DBM = DBManager(set_path=action[1], configFile=action[2])
elif len(action) > 1:
DBM = DBManager(set_path=action[1])
else:
self.logger.error(
'Path to the CheckM reference data must be specified.')
def binFiles(self, binInput, binExtension, bCalledGenes):
binFiles = []
binIDs = set()
isInputDir = True
if binInput is not None:
if os.path.isdir(binInput):
if binExtension[0] != '.':
binExtension = '.' + binExtension
all_files = os.listdir(binInput)
for f in all_files:
if f.endswith(binExtension):
binFile = os.path.join(binInput, f)
if os.stat(binFile).st_size == 0:
self.logger.warning(
"Skipping bin %s as it has a size of 0 bytes." % f)
else:
binFiles.append(binFile)
binIDs.add(os.path.basename(binFile))
else:
with open(binInput, "r") as oh:
for line in oh:
files = line.strip().split("\t")
binFile = files[1]
if bCalledGenes:
binFile = files[2]
if not os.path.exists(binFile):
self.logger.warning(
"Skipping bin %s as it doesn't exists." % f)
elif os.stat(binFile).st_size == 0:
self.logger.warning(
"Skipping bin %s as it has a size of 0 bytes." % f)
else:
binFiles.append(binFile)
binIDs.add(os.path.basename(binFile))
if not binFiles:
if isInputDir:
self.logger.error(
"No bins found. Check the extension (-x) used to identify bins.")
else:
self.logger.error(
"No bins found. Check the bins input table to verify bins exists.")
sys.exit(1)
if len(binIDs) != len(binFiles):
self.logger.error(
"There are redundant bin IDs, please check and update.")
sys.exit(1)
return sorted(binFiles)
def tree(self, options):
"""Tree command"""
self.logger.info(
'[CheckM - tree] Placing bins in reference genome tree.')
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
if not options.bCalledGenes:
if not checkNuclotideSeqs(binFiles):
return
else:
if not checkProteinSeqs(binFiles):
return
# setup directory structure
makeSurePathExists(os.path.join(options.output_dir, 'bins'))
makeSurePathExists(os.path.join(options.output_dir, 'storage'))
# find phylogenetically informative genes in genome bins
mgf = MarkerGeneFinder(options.threads)
binIdToModels = mgf.find(binFiles,
options.output_dir,
DefaultValues.HMMER_TABLE_PHYLO_OUT,
DefaultValues.HMMER_PHYLO_OUT,
DefaultValues.PHYLO_HMM_MODELS,
options.bKeepAlignment,
options.bNucORFs,
options.bCalledGenes)
# write model information to file
markerSetParser = MarkerSetParser(options.threads)
hmmModelInfoFile = os.path.join(
options.output_dir, 'storage', DefaultValues.PHYLO_HMM_MODEL_INFO)
markerSetParser.writeBinModels(binIdToModels, hmmModelInfoFile)
# calculate statistics for each genome bin
binStats = BinStatistics(options.threads)
binStats.calculate(binFiles, options.output_dir,
DefaultValues.BIN_STATS_PHYLO_OUT)
# align identified marker genes
HA = HmmerAligner(options.threads)
resultsParser = HA.makeAlignmentToPhyloMarkers(options.output_dir,
DefaultValues.PHYLO_HMM_MODELS,
DefaultValues.HMMER_TABLE_PHYLO_OUT,
binIdToModels,
False,
DefaultValues.E_VAL,
DefaultValues.LENGTH,
False,
os.path.join(
options.output_dir, 'storage', 'tree')
)
# place bins into genome tree
# fix at one thread to keep memory requirements reasonable
pplacer = PplacerRunner(threads=options.pplacer_threads)
pplacer.run(binFiles, resultsParser,
options.output_dir, options.bReducedTree)
self.timeKeeper.printTimeStamp()
def treeQA(self, options):
"""QA command"""
self.logger.info(
'[CheckM - tree_qa] Assessing phylogenetic markers found in each bin.')
checkDirExists(options.tree_dir)
# set HMM file for each bin
markerSetParser = MarkerSetParser()
hmmModelInfoFile = os.path.join(
options.tree_dir, 'storage', DefaultValues.PHYLO_HMM_MODEL_INFO)
binIdToModels = markerSetParser.loadBinModels(hmmModelInfoFile)
# calculate marker gene statistics
RP = ResultsParser(binIdToModels)
binStats = RP.analyseResults(options.tree_dir,
DefaultValues.BIN_STATS_PHYLO_OUT,
DefaultValues.HMMER_TABLE_PHYLO_OUT)
# determine taxonomy of each bin
treeParser = TreeParser()
treeParser.printSummary(
options.out_format, options.tree_dir, RP, options.bTabTable, options.file, binStats)
if options.file != '':
self.logger.info('QA information written to: ' + options.file)
self.timeKeeper.printTimeStamp()
def lineageSet(self, options, db=None):
"""Lineage set command"""
self.logger.info(
'[CheckM - lineage_set] Inferring lineage-specific marker sets.')
checkDirExists(options.tree_dir)
# set HMM file for each bin
markerSetParser = MarkerSetParser()
hmmModelInfoFile = os.path.join(
options.tree_dir, 'storage', DefaultValues.PHYLO_HMM_MODEL_INFO)
binIdToModels = markerSetParser.loadBinModels(hmmModelInfoFile)
# calculate marker gene statistics
resultsParser = ResultsParser(binIdToModels)
resultsParser.analyseResults(options.tree_dir,
DefaultValues.BIN_STATS_PHYLO_OUT,
DefaultValues.HMMER_TABLE_PHYLO_OUT)
# These options are incompatible with how the lineage-specific marker set is selected, so
# the default values are currently hard-coded
options.num_genomes_markers = 2
options.bootstrap = 0
options.bRequireTaxonomy = False
treeParser = TreeParser()
treeParser.getBinMarkerSets(options.tree_dir, options.marker_file,
options.num_genomes_markers,
options.bootstrap, options.bNoLineageSpecificRefinement,
options.bForceDomain, options.bRequireTaxonomy,
resultsParser, options.unique, options.multi)
self.logger.info('Marker set written to: ' + options.marker_file)
self.timeKeeper.printTimeStamp()
def taxonList(self, options, db=None):
"""Lineage set command"""
self.logger.info(
'[CheckM - taxon_list] Listing available taxonomic-specific marker sets.')
taxonParser = TaxonParser()
taxonParser.list(options.rank)
self.timeKeeper.printTimeStamp()
def taxonSet(self, options, db=None):
"""Taxon set command"""
self.logger.info(
'[CheckM - taxon_set] Generate taxonomic-specific marker set.')
path = os.path.split(options.marker_file)[0]
if path:
makeSurePathExists(path)
taxonParser = TaxonParser()
bValidSet = taxonParser.markerSet(
options.rank, options.taxon, options.marker_file)
if bValidSet:
self.logger.info('Marker set written to: ' + options.marker_file)
self.timeKeeper.printTimeStamp()
def analyze(self, options, db=None):
"""Analyze command"""
self.logger.info(
'[CheckM - analyze] Identifying marker genes in bins.')
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
if not options.bCalledGenes:
if not checkNuclotideSeqs(binFiles):
return
else:
if not checkProteinSeqs(binFiles):
return
# setup directory structure
makeSurePathExists(options.output_dir)
makeSurePathExists(os.path.join(options.output_dir, 'bins'))
makeSurePathExists(os.path.join(options.output_dir, 'storage'))
makeSurePathExists(os.path.join(
options.output_dir, 'storage', 'aai_qa'))
# find marker genes in genome bins
mgf = MarkerGeneFinder(options.threads)
binIdToModels = mgf.find(binFiles,
options.output_dir,
DefaultValues.HMMER_TABLE_OUT,
DefaultValues.HMMER_OUT,
options.marker_file,
options.bKeepAlignment,
options.bNucORFs,
options.bCalledGenes)
markerSetParser = MarkerSetParser(options.threads)
binIdToBinMarkerSets = markerSetParser.getMarkerSets(options.output_dir,
getBinIdsFromOutDir(
options.output_dir),
options.marker_file)
hmmModelInfoFile = os.path.join(
options.output_dir, 'storage', DefaultValues.CHECKM_HMM_MODEL_INFO)
markerSetParser.writeBinModels(binIdToModels, hmmModelInfoFile)
self.timeKeeper.printTimeStamp()
# HMM model file
if markerSetParser.markerFileType(options.marker_file) == BinMarkerSets.HMM_MODELS_SET:
markerFile = options.marker_file
else:
markerFile = DefaultValues.HMM_MODELS
# align marker genes with multiple hits within a bin
HA = HmmerAligner(options.threads)
HA.makeAlignmentsOfMultipleHits(options.output_dir,
markerFile,
DefaultValues.HMMER_TABLE_OUT,
binIdToModels,
binIdToBinMarkerSets,
False,
DefaultValues.E_VAL,
DefaultValues.LENGTH,
os.path.join(
options.output_dir, 'storage', 'aai_qa')
)
self.timeKeeper.printTimeStamp()
# calculate statistics for each genome bin
binStats = BinStatistics(options.threads)
binStats.calculate(binFiles, options.output_dir,
DefaultValues.BIN_STATS_OUT)
self.timeKeeper.printTimeStamp()
# align top hit to each marker if requested
if options.bAlignTopHit:
alignmentOutputFolder = os.path.join(
options.output_dir, 'storage', 'alignments')
makeSurePathExists(alignmentOutputFolder)
HA = HmmerAligner(options.threads)
resultsParser = HA.makeAlignmentTopHit(options.output_dir,
options.marker_file,
DefaultValues.HMMER_TABLE_OUT,
binIdToModels,
False,
DefaultValues.E_VAL,
DefaultValues.LENGTH,
True,
alignmentOutputFolder
)
# report marker gene data
fout = open(os.path.join(alignmentOutputFolder,
'alignment_info.tsv'), 'w')
fout.write('Marker Id\tLength (bp)\n')
markerIds = resultsParser.models[list(
resultsParser.models.keys())[0]].keys()
for markerId in markerIds:
fout.write('%s\t%d\n' % (markerId, resultsParser.models[list(
resultsParser.models.keys())[0]][markerId].leng))
fout.close()
self.logger.info(
'Alignments to top hits stored in: ' + alignmentOutputFolder)
self.timeKeeper.printTimeStamp()
def qa(self, options):
"""QA command"""
self.logger.info('[CheckM - qa] Tabulating genome statistics.')
checkDirExists(options.analyze_dir)
if options.exclude_markers:
checkFileExists(options.exclude_markers)
# calculate AAI between marks with multiple hits in a single bin
aai = AminoAcidIdentity()
aai.run(options.aai_strain, options.analyze_dir, options.alignment_file)
# get HMM file for each bin
markerSetParser = MarkerSetParser(options.threads)
hmmModelInfoFile = os.path.join(
options.analyze_dir, 'storage', DefaultValues.CHECKM_HMM_MODEL_INFO)
binIdToModels = markerSetParser.loadBinModels(hmmModelInfoFile)
binIdToBinMarkerSets = markerSetParser.getMarkerSets(options.analyze_dir,
getBinIdsFromOutDir(
options.analyze_dir),
options.marker_file,
options.exclude_markers)
# get results for each bin
RP = ResultsParser(binIdToModels)
RP.analyseResults(options.analyze_dir,
DefaultValues.BIN_STATS_OUT,
DefaultValues.HMMER_TABLE_OUT,
bIgnoreThresholds=options.bIgnoreThresholds,
evalueThreshold=options.e_value,
lengthThreshold=options.length,
bSkipPseudoGeneCorrection=options.bSkipPseudoGeneCorrection,
bSkipAdjCorrection=options.bSkipAdjCorrection
)
RP.printSummary(options.out_format,
aai, binIdToBinMarkerSets,
options.bIndividualMarkers,
options.coverage_file,
options.bTabTable,
options.file,
anaFolder=options.analyze_dir)
RP.cacheResults(options.analyze_dir,
binIdToBinMarkerSets,
options.bIndividualMarkers)
if options.file != '':
self.logger.info('QA information written to: ' + options.file)
self.timeKeeper.printTimeStamp()
def gcPlot(self, options):
"""GC plot command"""
self.logger.info(
'[CheckM - gc_plot] Creating GC histogram and delta-GC plot.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
plots = GcPlots(options)
filesProcessed = 1
for f in binFiles:
self.logger.info('Plotting GC plots for %s (%d of %d)' %
(f, filesProcessed, len(binFiles)))
filesProcessed += 1
plots.plot(f, options.distributions)
binId = binIdFromFilename(f)
outputFile = os.path.join(
options.output_dir, binId) + '.gc_plots.' + options.image_type
plots.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def codingDensityPlot(self, options):
"""Coding density plot command"""
self.logger.info(
'[CheckM - coding_plot] Creating coding density histogram and delta-CD plot.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
plots = CodingDensityPlots(options)
filesProcessed = 1
for f in binFiles:
self.logger.info('Plotting coding density plots for %s (%d of %d)' % (
f, filesProcessed, len(binFiles)))
filesProcessed += 1
plots.plot(f, options.distributions)
binId = binIdFromFilename(f)
outputFile = os.path.join(
options.output_dir, binId) + '.coding_density_plots.' + options.image_type
plots.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def tetraDistPlot(self, options):
"""Tetranucleotide distance plot command"""
self.logger.info(
'[CheckM - tetra_plot] Creating tetra-distance histogram and delta-TD plot.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
genomicSignatures = GenomicSignatures(K=4, threads=1)
tetraSigs = genomicSignatures.read(options.tetra_profile)
plots = TetraDistPlots(options)
filesProcessed = 1
for f in binFiles:
self.logger.info('Plotting tetranuclotide distance plots for %s (%d of %d)' % (
f, filesProcessed, len(binFiles)))
filesProcessed += 1
binId = binIdFromFilename(f)
plots.plot(f, tetraSigs, options.distributions)
outputFile = os.path.join(
options.output_dir, binId) + '.tetra_dist_plots.' + options.image_type
plots.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def distributionPlots(self, options):
"""Reference distribution plot command"""
self.logger.info(
'[CheckM - dist_plot] Creating GC, CD, and TD distribution plots.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
genomicSignatures = GenomicSignatures(K=4, threads=1)
tetraSigs = genomicSignatures.read(options.tetra_profile)
plots = DistributionPlots(options)
filesProcessed = 1
for f in binFiles:
self.logger.info('Plotting reference distribution plots for %s (%d of %d)' % (
f, filesProcessed, len(binFiles)))
filesProcessed += 1
binId = binIdFromFilename(f)
plots.plot(f, tetraSigs, options.distributions)
outputFile = os.path.join(
options.output_dir, binId) + '.ref_dist_plots.' + options.image_type
plots.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def gcBiasPlot(self, options):
"""GC bias plot command"""
self.logger.info(
'[CheckM - gc_bias_plot] Plotting bin coverage as a function of GC.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
coverageWindows = CoverageWindows(options.threads)
coverageProfile = coverageWindows.run(
binFiles, options.bam_file, options.all_reads, options.min_align, options.max_edit_dist, options.window_size)
plots = GcBiasPlot(options)
filesProcessed = 1
for f in binFiles:
self.logger.info('Plotting GC plots for %s (%d of %d)' %
(f, filesProcessed, len(binFiles)))
filesProcessed += 1
plots.plot(f, coverageProfile)
binId = binIdFromFilename(f)
outputFile = os.path.join(
options.output_dir, binId) + '.gc_bias_plot.' + options.image_type
plots.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def nxPlot(self, options):
"""Nx-plot command"""
self.logger.info('[CheckM - nx_plot] Creating Nx-plots.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
nx = NxPlot(options)
filesProcessed = 1
for f in binFiles:
binId = binIdFromFilename(f)
self.logger.info('Plotting Nx-plot for %s (%d of %d)' %
(binId, filesProcessed, len(binFiles)))
filesProcessed += 1
nx.plot(f)
outputFile = os.path.join(
options.output_dir, binId) + '.nx_plot.' + options.image_type
nx.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def lengthHistogram(self, options):
"""Sequence length histogram command"""
self.logger.info(
'[CheckM - len_hist] Creating sequence length histogram.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
plot = LengthHistogram(options)
filesProcessed = 1
for f in binFiles:
binId = binIdFromFilename(f)
self.logger.info('Plotting sequence length histogram for %s (%d of %d)' % (
binId, filesProcessed, len(binFiles)))
filesProcessed += 1
plot.plot(f)
outputFile = os.path.join(
options.output_dir, binId) + '.len_hist.' + options.image_type
plot.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def markerPlot(self, options):
"""Marker gene position plot command"""
self.logger.info(
'[CheckM - marker_plot] Creating marker gene position plot.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(options.output_dir)
# generate plot for each bin
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
resultsParser = ResultsParser(None)
markerGeneStats = resultsParser.parseMarkerGeneStats(
options.results_dir)
binStats = resultsParser.parseBinStatsExt(options.results_dir)
plot = MarkerGenePosPlot(options)
filesProcessed = 1
for f in binFiles:
binId = binIdFromFilename(f)
self.logger.info('Plotting marker gene position plot for %s (%d of %d)' % (
binId, filesProcessed, len(binFiles)))
filesProcessed += 1
if binId not in markerGeneStats or binId not in binStats:
continue # bin has no marker genes
bPlotted = plot.plot(f, markerGeneStats[binId], binStats[binId])
if bPlotted:
outputFile = os.path.join(
options.output_dir, binId) + '.marker_pos_plot.' + options.image_type
plot.savePlot(outputFile, dpi=options.dpi)
self.logger.info('Plot written to: ' + outputFile)
else:
self.logger.info('No marker genes found in bin.')
self.timeKeeper.printTimeStamp()
def unbinned(self, options):
"""Unbinned Command"""
self.logger.info('[CheckM - unbinned] Identify unbinned sequences.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
unbinned = Unbinned()
unbinned.run(binFiles, options.seq_file, options.output_seq_file,
options.output_stats_file, options.min_seq_len)
self.logger.info('Unbinned sequences written to: ' +
options.output_seq_file)
self.logger.info(
'Unbinned sequences statistics written to: ' + options.output_stats_file)
self.timeKeeper.printTimeStamp()
def coverage(self, options):
"""Coverage command"""
self.logger.info(
'[CheckM - coverage] Calculating coverage of sequences.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
makeSurePathExists(os.path.dirname(options.output_file))
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
coverage = Coverage(options.threads)
coverage.run(binFiles, options.bam_files, options.output_file, options.all_reads,
options.min_align, options.max_edit_dist, options.min_qc)
self.logger.info(
'Coverage information written to: ' + options.output_file)
self.timeKeeper.printTimeStamp()
def tetraSignatures(self, options):
"""Tetranucleotide signature command"""
self.logger.info(
'[CheckM - tetra] Calculating tetranucleotide signature of sequences.')
checkFileExists(options.seq_file)
makeSurePathExists(os.path.dirname(options.output_file))
tetraSig = GenomicSignatures(4, options.threads)
tetraSig.calculate(options.seq_file, options.output_file)
self.logger.info(
'Tetranucletoide signatures written to: ' + options.output_file)
self.timeKeeper.printTimeStamp()
def profile(self, options):
"""Profile command"""
self.logger.info(
'[CheckM - profile] Calculating percentage of reads mapped to each bin.')
checkFileExists(options.coverage_file)
profile = Profile()
profile.run(options.coverage_file, options.file, options.bTabTable)
if options.file != '':
self.logger.info('Profile information written to: ' + options.file)
self.timeKeeper.printTimeStamp()
def merge(self, options):
"""Merge command"""
self.logger.info(
'[CheckM - merge] Identifying bins with complementary sets of marker genes.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
if not options.bCalledGenes:
if not checkNuclotideSeqs(binFiles):
return
else:
if not checkProteinSeqs(binFiles):
return
markerSetParser = MarkerSetParser()
if markerSetParser.markerFileType(options.marker_file) == BinMarkerSets.TREE_MARKER_SET:
self.logger.error(
'Merge command requires a taxonomic-specific marker set or a user-defined HMM file.\n')
return
# setup directory structure
makeSurePathExists(options.output_dir)
makeSurePathExists(os.path.join(options.output_dir, 'bins'))
makeSurePathExists(os.path.join(options.output_dir, 'storage'))
makeSurePathExists(os.path.join(options.output_dir, 'storage', 'hmms'))
binIds = []
for binFile in binFiles:
binIds.append(binIdFromFilename(binFile))
# find marker genes in genome bins
mgf = MarkerGeneFinder(options.threads)
binIdToModels = mgf.find(binFiles,
options.output_dir,
"merger.table.txt",
"merger.hmmer3",
options.marker_file,
False,
False,
options.bCalledGenes)
# get HMM file for each bin
markerSetParser = MarkerSetParser()
binIdToBinMarkerSets = markerSetParser.getMarkerSets(
options.output_dir, binIds, options.marker_file)
# compare markers found in each bin
merger = Merger()
outputFile = merger.run(binFiles, options.output_dir, "merger.table.txt", binIdToModels, binIdToBinMarkerSets,
options.delta_comp, options.delta_cont, options.merged_comp, options.merged_cont)
self.logger.info('Merger information written to: ' + outputFile)
self.timeKeeper.printTimeStamp()
def outliers(self, options):
"""Outlier command"""
self.logger.info('[CheckM - outlier] Identifying outliers in bins.')
checkBinInputExists(options.bin_input, options.bCalledGenes)
checkFileExists(options.tetra_profile)
makeSurePathExists(os.path.dirname(options.output_file))
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
binTools = BinTools()
binTools.identifyOutliers(options.results_dir,
binFiles,
options.tetra_profile,
options.distributions,
options.report_type,
options.output_file)
self.logger.info('Outlier information written to: ' +
options.output_file)
self.timeKeeper.printTimeStamp()
def modify(self, options):
"""Modify command"""
self.logger.info('[CheckM - modify] Modifying sequences in bin.')
makeSurePathExists(os.path.dirname(options.output_file))
if not (options.add or options.remove or options.outlier_file):
self.logger.error('No modification to bin requested.\n')
sys.exit(1)
if (options.add or options.remove) and options.outlier_file:
self.logger.error(
"The 'outlier_file' option cannot be specified with 'add' or 'remove'.\n")
sys.exit(1)
binTools = BinTools()
if options.add or options.remove:
binTools.modify(options.bin_file, options.seq_file,
options.add, options.remove, options.output_file)
elif options.outlier_file:
binTools.removeOutliers(
options.bin_file, options.outlier_file, options.output_file)
self.logger.info('Modified bin written to: ' + options.output_file)
self.timeKeeper.printTimeStamp()
def unique(self, options):
"""Unique command"""
self.logger.info(
'[CheckM - unique] Ensuring no sequences are assigned to multiple bins.')
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
binTools = BinTools()
binTools.unique(binFiles)
self.timeKeeper.printTimeStamp()
def ssuFinder(self, options):
"""SSU finder command"""
self.logger.info(
'[CheckM - ssu_finder] Identifying SSU (16S/18S) rRNAs in sequences.')
binFiles = self.binFiles(
options.bin_input, options.extension, options.bCalledGenes)
checkFileExists(options.seq_file)
makeSurePathExists(options.output_dir)
ssuFinder = SSU_Finder(options.threads)
ssuFinder.run(options.seq_file, binFiles, options.output_dir,
options.evalue, options.concatenate)
self.timeKeeper.printTimeStamp()
def test(self, options):
"""Quick test of CheckM"""
self.logger.info(
'[CheckM - Test] Processing E.coli K12-W3310 to verify operation of CheckM.')
verifyEcoli = VerifyEcoli()
verifyEcoli.run(self, options.output_dir)
self.timeKeeper.printTimeStamp()
def parseOptions(self, options):
"""Parse user options and call the correct pipeline(s)"""
try:
if options.file == "stdout":
options.file = ''
except:
pass
if(options.subparser_name == "data"):
self.updateCheckM_DB(options)
elif(options.subparser_name == 'tree'):
self.tree(options)
elif(options.subparser_name == 'tree_qa'):
self.treeQA(options)
elif(options.subparser_name == 'lineage_set'):
self.lineageSet(options)
elif(options.subparser_name == 'taxon_list'):
self.taxonList(options)
elif(options.subparser_name == 'taxon_set'):
self.taxonSet(options)
elif(options.subparser_name == 'analyze'):
self.analyze(options)
elif(options.subparser_name == 'qa'):
self.qa(options)
elif(options.subparser_name == 'lineage_wf'):
options.marker_file = os.path.join(
options.output_dir, 'lineage.ms')
options.tree_dir = options.output_dir
options.analyze_dir = options.output_dir
options.out_format = 1
options.bAlignTopHit = False
options.exclude_markers = None
options.coverage_file = None
self.tree(options)
self.lineageSet(options)
self.analyze(options)
self.qa(options)
elif(options.subparser_name == 'taxonomy_wf'):
options.marker_file = os.path.join(
options.output_dir, options.taxon + '.ms')
options.analyze_dir = options.output_dir
options.out_format = 1
options.bAlignTopHit = False
options.exclude_markers = None
self.taxonSet(options)
self.analyze(options)
self.qa(options)
elif(options.subparser_name == 'gc_plot'):
self.gcPlot(options)
elif(options.subparser_name == 'coding_plot'):
self.codingDensityPlot(options)
elif(options.subparser_name == 'tetra_plot'):
self.tetraDistPlot(options)