-
Notifications
You must be signed in to change notification settings - Fork 1
/
merge_primerid_read_groups.pl
executable file
·1532 lines (1372 loc) · 82.6 KB
/
merge_primerid_read_groups.pl
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
#!/usr/bin/env perl
use warnings;
select STDOUT; # Turn off buffering for STDOUT for printing from multiple processes at the same time.
$| = 1;
#Add use lib statement to assume there is a directory at the same level as bin in which the script is run, called 'lib'
use FindBin;
use lib "$FindBin::Bin/../lib";
use lib "$FindBin::Bin";
use strict;
use FileHandle;
use aomisc;
use Cwd;
use diagnostics;
use Getopt::Long;
use Data::Dumper;
use File::Basename;
use Bio::DB::Sam; #http://search.cpan.org/~lds/Bio-SamTools-1.37/lib/Bio/DB/Sam.pm
use Bio::SeqIO;
use Bio::Tools::Run::Alignment::Clustalw;
#use Bio::Tools::Run::Alignment::MAFFT;
use Bio::AlignIO;
use Bio::SimpleAlign;
use lib dirname (__FILE__);
use Statistics::Distributions;
use Parallel::Loops;
#use Loops;
use File::Temp;
use Statistics::R;
use File::Copy;
#use Bio::Perl;
#use Getopt::Std;
#use PostData;
#use Fasta_utils;
#use feature ":5.10"; #allows say (same as print, but adds "\n"), given/when switch, etc.
# Andrew J. Oler, PhD
# Computational Biology Section
# Bioinformatics and Computational Biosciences Branch (BCBB)
# OCICB/OSMO/OD/NIAID/NIH
# Bethesda, MD 20892
#
# andrew.oler@gmail.com
#
#This package is free software; you can redistribute it and/or modify
#it under the terms of the GPL (either version 1, or at your option,
#any later version) or the Artistic License 2.0.
#my %options; #Hash in which to store option arguments
#use vars qw($opt_s $opt_f $opt_n $opt);
#getopts ('s:f:n:bda:g:om:i:r:ecu:kh:j:l:ypx:',\%options);
#Print out the options
if (@ARGV){ print STDERR "Arguments: ", join " ", @ARGV, "\n"; }
my $PWD = pwd_for_hpc();
my $bam2fastx_bin = $PWD.'/bam2fastx'; # philip macmenamin
#my $mafft_bin = $PWD.'/mafft';
my $mafft_bin = 'mafft';
my $save;
my $files;
my $verbose;
my $output;
my $gzip;
my $baseq = 0;
my $mapq = 0;
my $fasta;
my $debug;
my $min_reads = 3;
my $max_reads;
my $cpu = 1;
my $gap = 'auto'; # Either auto or a number. If 'auto', will be replaced by a number later for calculations.
my $R1_length = 'auto'; # Either auto or a number. If 'auto', will be replaced by a number later for calculations.
my $ambig = 0;
my $wide_gap = 0;
my $clustalw;
my $plot_counts;
my $tiebreaker;
my $ref;
my $min_auto_gap_size = 1;
my $min_freq = "";
my $plot_only;
my $temp_dir = "/tmp";
GetOptions(
'save=s' => \$save,
'output=s' => \$output,
'verbose' => \$verbose,
'files=s' => \$files,
'gzip' => \$gzip,
'baseq=s' => \$baseq,
'mapq=s' => \$mapq,
'fasta=s' => \$fasta,
'debug' => \$debug,
'min_reads|m=s' => \$min_reads,
'max_reads|x=s' => \$max_reads,
'cpu|p=s' => \$cpu,
'gap|g=s' => \$gap,
'R1_length|r=s' => \$R1_length,
'ambig|n=s' => \$ambig,
'wide_gap' => \$wide_gap,
'clustalw' => \$clustalw,
'plot_counts' => \$plot_counts,
'tiebreaker|t' => \$tiebreaker,
'ref=s' => \$ref,
'min_auto_gap_size=i' => \$min_auto_gap_size,
'min_freq=s' => \$min_freq,
'plot_only' => \$plot_only,
'temp_dir=s' => \$temp_dir,
);
#-----------------------------------------------------------------------------
#----------------------------------- MAIN ------------------------------------
#-----------------------------------------------------------------------------
my $usage = basename($0)." takes one or more BAM files and outputs a consensus for each
primerID or barcode (as a BAM file). The primerID or barcode should be in the read name
(filtering with filter_fastq_by_barcode_length.pl before alignment will do this for you).
Each primerID/barcode represents a single original library fragment; groups of reads with
the same primerID/barcode are probably PCR duplicates; a consensus will be called. Each
group must have at least 2 sequences (this minimum can be increased; default is actually 3);
reads in a primerID group are aligned with mafft or clustalw and a consensus is decided
based on majority rule and ties are converted to ambiguous characters. Requires mafft
executable on the PATH (or clustalw if --clustalw option is used).
Prints out a fasta file of consensus reads *.cons.fasta (and a separate fasta file
*.ambig.fasta for sequences with ambiguous character counts above the threshold set in
--ambig), one output read per primerID group.
Processes about 13 primerID groups/second with -p 20.
OPTIONS:
--files One or more BAM Files, comma-delimited. Required. If multiple samples
are input, they will be treated separately. (The files can also be received as the
first argument.) Alternatively, fasta files can be accepted as input as well (use
.fasta or .fa extension).
--save Directory in which to save files. Default = pwd. If folder doesn't exist,
it will be created.
-m/--min_reads Minimum number of reads per primerID group. Default = 3.
-x/--max_reads Maximum number of reads per primerID group. No limit by default.
-p/--cpu Number of processors to use. Default = 1.
-n/--ambig Number of ambiguous bases in the consensus read (outside of a middle gap)
allowed for reporting consensus reads. Default = 0.
-t/--tiebreaker Use intra-sample consensus as a tie-breaker in cases where there is a tie
for the majority base at a position in a primerID group. e.g., 2G, 2A.
Recommended if using --min_reads 2. It is recommended to supply reference fasta to
--ref option to speed up the step to create intra-sample consensus.
--ref Reference cds file that the reads in the BAM file were aligned to. Used with
--tiebreaker.
--clustalw Use clustalw to run alignments. Default is to use mafft. *Executables must be
on the PATH.* Clustalw is about 1.4x faster but mafft seems to do a better job.
-g/--gap Approximate gap size between the reads. Default = 'auto', which means the gap
size will be auto-detected. The effect of specifying the gap is that Ns are
allowed in this region. Assumes that the reads were not trimmed before
concatenating with Ns. 'auto' is recommended for multiple file input as the value
will reset for each file.
-r/--R1_length Average length of R1 portion of the reads in the concatenated reads. This
parameter is used to define the beginning of an internal gap (indicated as stretch
of Ns) between two concatenated reads. Default = 'auto', which means this will
be auto-detected from the reads. If --R1_length is specified, --gap will also be
turned on. 'auto' is recommended for multiple file input as the value
will reset for each file.
--wide_gap When selecting --gap and --R1_length in 'auto' mode, this setting affects
whether the widest possible gap is chosen or a more conservative gap is chosen.
If this option is selected, the widest possible gap is chosen (gap start position
is smallest R1_length and end position is largest R1_length plus largest gap).
The default is a more conservative gap with gap start position as the most common
R1_length and gap end position as common R1_length plus most common gap size.
--min_auto_gap_size When selecting --gap and --R1_length in 'auto' mode, this setting affects
the minimum gap size to use in the search. Default = 1. At least 20% of the reads
need to have a gap of this size in order for it to be considered a gap.
--plot_counts Make a graph of primerID group counts based on size of group (i.e., number
of reads with the same primerID).
--plot_only Simply plot primerID counts and then quit.
--min_freq When calling a consensus base for a particular position, the frequency of the
major base should be equal to or higher than this value. If the value falls below
this threshold, the assigned base is N. The default is to take the major base
regardless of the frequency. Suggested: value between 0.60 and 0.75. Note that if
there is a tie between two residues, an IUPAC ambiguous residue will be assigned
regardless of the frequency.
--temp_dir Directory to use for temporary files. Default is /tmp .
";
# To Do:
# Add check for samtools on the command line.
# Add option for maximum per group. Groups with too many reads might have a repeated barcode. Maybe this could be chosen automatically by the distribution of the numbers of reads per barcode group (e.g., don't consider the top 5th percentile) Or maybe have some way to detect barcode groups that are too different/inhomogeneous to automatically reject...
# Make output BAM file conform well to specifications. Is there any more information from the original BAM files I could include in or recalculate for the output BAM file?
# Add back ability to report average base quality for reads (either root mean square, fisher's method or some other method) "Base quality scores from multiple reads are merged using Fisher's method."
# Make Bio::Tools::Run::Alignment::Clustalw requirement conditional on --clustalw option (using eval)
# Take fasta or fastq input
# Clean out old subs not being used anymore.
# Modify parallelization to reduce memory usage. Make multiple threads and write results out to temp files (save names of temp files to shared array for subsequent concatenation). How to make different names for files? Increment n in the while loop.
# Or I could split the file when grouping by primerID group and send off multiple jobs to the cluster, then manually merge the files afterwards. Could use Queue.
# Change log
# 130301
# Added --group. Minimum number of reads per barcode group. Default = 2.
# 130403
# Added ability to output a consensus bam file by default. BAM file that has one read per barcode group so that we can use vprofiler, vphaser, etc.
# 2013-05-24
# Removed the nucleotide and amino acid tally part (that will be in convert_reads_to_amino_acids.pl or potentially another script altogether); now it just outputs a consensus BAM. As part of this, removed --labels option because that was just related to the output table.
# Removed the part where it first checks if the read overlaps with an exon. At this stage, it is not important. As part of this, removed several subroutines and --gff option.
# Commented out the fasta file input into the BAM object. It's not being used at the moment since I'm calling the reference sequence with $a->dna, which uses the MD tag.
# --fasta Reference fasta file. Required. Used to break ties when reporting the
# consensus sequence.
# 2013-06-07
# Set $combined_pvalue to 3.162e-26 if calculated $combined_pvalue is 0 from chisq distribution.
# 2013-09-27
# Modified make_consensus sub to change the output file name. Also, added samtools sort step.
# 2013-09-30
# Modified read_bam sub to increment $read_tally->{$barcode}->{bad} if reference sequence doesn't match for all of the reads of a primerID group (meaning they aligned to different regions). Then in make_consensus sub, these primerID groups are skipped.
# Added @pos the list of things to check to see if it is the same for all of the reads in a primerID group.
# 2013-11-14
# Modified make_consensus and read_bam subroutines. Almost complete rewrite. (saved the old subroutines as .._old)
# 2013-12-10
# Changed --group option to --min_reads and added --max_reads option.
# Removed check for min_reads in make_consensus subroutine ("if (scalar(@sequences) >= $min_reads){")now since all of those outside of the range set by min_reads and max_reads are deleted from the data structure in the read_bam step.
# Removed this part from the description: "The program assumes that indels are sequencing errors (e.g., ION Torrent), so insertions to the reference are deleted and deletions are filled with base X; this results in keeping the original reference frame." since indels are considered now.
# Removing this temporarily, until I add back functionality to get average base quality score of some sort
# Added --gap option.
# Ties result in ambiguous codes. If they are outside of the middle gap (if it exists)
# 2013-12-11
# Fixed some bugs regarding checking whether ambiguous bases are found in the internal gap or not
# Added --R1_length option to help with definition of the internal gap
# Added auto detection for --gap and --R1_length parameters. Set as default. Uses the first 1000 reads with a stretch of Ns >= 5bp long to determine the widest possible gap region.
# Changed @ambiguous to save the sequence and then print it out at the end.
# Added option --skinnier_gap.
# Printing out a table of positions where ambiguous bases were found at the end of the script
# 2013-12-13
# Made mafft the default aligner for making a consensus. It's about 1.4x slower than clustalw. Aligning with clustalw is still accessible by using option --clustalw.
# Made the skinny gap the default and changed the wider gap to the option.
# 2014-01-09
# Changed the default minimum to 3. Updated the $usage.
# Added $count to the temporary directory name to further avoid collisions. Also put the temp directories in /tmp/ instead of Cwd.
# 2014-04-01
# Changed make_consensus() sub to print out uppercase sequences to be more compatible with fastx_toolkit, which requires upper-case fasta sequences.
# 2014-06-02
# Changed read_bam to three subroutines: convert_bam_to_fasta, find_gap, and read_fasta. This way, we can read the file to find the gap and then read the file again to save to a hash. It is much cleaner than trying to get the gap and save some reads at the same time.
# Also changed it so that the number of reads to check is not a minimum, but a maximum, so that files with less than 1000 reads can be searched for a gap as well. In that case, it uses the $fraction of reads with a gap to determine whether to proceed to set $gap and $R1_length or not.
# Added an output file of counts per PrimerID group size for graphing. Also bridges to R to make a simple barplot of the PrimerID group sizes, saved as PDF.
# 2014-06-03
# Removed options:
#--mapq Minimum read mapping quality to consider. Default = 0.
#--baseq Minimum base quality to consider for output. Default = 0. Try 13.
# Added option --plot_counts to make the output file of counts per PrimerID group and the barplot optional, since a similar graph will also be produced by filter_fastq_by_primerid_length.pl, except that the graph by filter_fastq_by_primerid_length.pl will have number with zero as well.
# Allowed fasta file as input. (easier for testing/debugging)
# Added variable $ambig_summary_for_fasta_header_def to store information about ambiguities in the fasta header, to explain the reason a read was placed in the ambig fasta file.
# Added variable $res_num to keep track of residue numbers separately from $pos position in the alignment, in case of gaps inserted that will be removed later.
# 2014-06-10
# Added subroutine get_sample_consensus and options --tiebreaker and --ref. Modified make_consensus subroutine appropriately to use the intra-sample consensus as a tie-breaker.
# 2014-06-11
# Added step to read_fasta to print out fasta files for reads that are above maximum --max_reads value and below minimum --min_reads value. This is useful for downstream processing to get background frequency rate for unmerged reads. Added print_out_of_range_fasta sub to do the printing.
# 2014-07-17
# Fixed a bug in the table of ambiguous positions where I was printing the line returns to STDOUT and the rest of the table to STDERR.
# 2014-10-14
# Fixed a bug in read_fasta subroutine where the program was appending belowmin and abovemax reads to existing files. Now it checks if the file exists and deletes it first before writing any reads.
# 2015-05-13
# Added --min_auto_gap_size option. Default = 3.
# Changed name of output ambig.fasta file to remove the threshold number of ambig positions
# 2016-04-19
# Added --plot_only
# Allowing .fasta input again.
# Added --temp_dir. /tmp/ is default, but I want to try .../scratch in case local /tmp is getting overloaded.
# 2016-06-18
# UPdated samtools in repo to 1.3. Added bcftools, vcfutils and seqtk to the repo.
# Requires samtools, bcftools, vcfutils.pl and seqtk on the PATH.
# 2017-02-11
# Added base counts before and after merging primerid groups so we can do noise correction.
# 2017-02-25
# Fixed a bug in counting up total bases in input reads
# Add $ambig_summary_for_fasta_header_def to header for .cons.fasta output too, not just .ambig.fasta output.
unless ($files||$ARGV[0]){ print STDERR "$usage\n"; exit; } #fasta and gff are required
unless($files){
if (scalar(@ARGV)>1){ #This will allow you to use wildcard to pass files to the script from the command line. e.g, script.pl *.txt, and it will run through each.
$files = join ",", @ARGV;
}
else{
$files = $ARGV[0];
}
}
# Check options
unless ($gap =~ m/^\d+$/ || $gap =~ m/^auto$/i){
print STDERR "--gap option should either be a number or 'auto'\n";
exit;
}
unless ($R1_length =~ m/^\d+$/ || $R1_length =~ m/^auto$/i){
print STDERR "--R1_length option should either be a number or 'auto'\n";
exit;
}
my $save_dir = $save || Cwd::cwd();
unless (-d $save_dir){ mkdir($save_dir) or warn "$!\n" }
print STDERR "save directory: $save_dir\n";
unless (-d $temp_dir){ mkdir($temp_dir) or warn "$!\n" }
my $start_time = time;
my @files = &aomisc::get_files($files); #If allowing a directory, specify extension of the files in second argument, e.g., my @files = &get_files($files, 'bed');
my @suffixes = (qw(.bed .bed.gz .bed12 .bed12.gz .txt .txt.gz .BED .BED.gz .BED12 .BED12.gz .fasta .fa .FA .FASTA .FAS .fas), @SUFFIXES); #for fileparse. Feel free to add more accepted extensions. @SUFFIXES comes from aomisc.pm.
my $iupac = iupac_ambiguities(); # Get a hashref of iupac ambiguity codes.
# Parse the BAM files and output a consensus fasta file for each input file
for (my $i = 0; $i < @files; $i++){
my $file = $files[$i];
my $sample_consensus_seq = "";
if ($tiebreaker){
$sample_consensus_seq = get_sample_consensus($file, $ref); # Takes BAM file and optionally a reference, returns sequence with same coordinates as reference.
}
my $fasta = convert_bam_to_fasta($file);
find_gap($fasta); # Modifies ($gap,$R1_length) global parameters if either is set as 'auto'; otherwise, provides some warnings if user-defined parameters are outside predicted based on auto-detection
my $read_tally = read_fasta($fasta);
# print Dumper($read_tally); exit;
my $consensus_sequences = make_consensus($read_tally, $file, $sample_consensus_seq) unless $plot_only; # Need to pass it the file as well, so it can use the name to construct a new name for the consensus bam/fastq/fasta file
}
&elapsed($start_time, 'Total', $verbose);
#-----------------------------------------------------------------------------
#---------------------------------- SUBS -------------------------------------
#-----------------------------------------------------------------------------
sub get_sample_consensus {
# Read a BAM file and create a single fasta consensus sequence for all reads in the file.
# Requires samtools mpileup, bcftools, vcfutils.pl and seqtk (for BAM input)
# If a reference fasta is provided (the reference to which the reads were aligned to make the BAM file), this subroutine runs much faster. (e.g., 2 seconds compared to 27 seconds for 150K-read BAM file.)
# If input file is FASTA format, then align with BWA first
my ($file,$ref) = @_;
# Paths
my $BWA = $PWD . "/bwa";
my $samtools = $PWD . "/samtools";
my $seqtk = $PWD . "/seqtk";
my $bcftools = $PWD . "/bcftools";
my $vcfutils = $PWD . "/vcfutils.pl";
# Set up temporary directory
my $tempdir = File::Temp->newdir( "/$temp_dir/fasta_file_sample_consensus_tempXXXXXX" );
# Make sure we have a BAM file for making a consensus. If not, align to the reference with BWA MEM.
my $bam = ""; # bam file name
if ($file =~ m/.bam$/i){
$bam = $file;
}
else {
# Input file is FASTA
# Align the reads to reference first.
die "Please provide reference file if input file is FASTA format!\n" unless ($ref);
print STDERR "Input is FASTA format -- attempting to align to reference before computing intra-sample consensus.\n\n";
my ($file_prefix,$dir,$ext) = fileparse($file,@suffixes);
my $bam_prefix = $tempdir ."/". $file_prefix;
$bam = $bam_prefix . ".bam";
my $temp_sam = $tempdir . "/temp.sam.gz";
# my $bwa_mem_cmd = "bwa index $ref; bwa mem -t $cpu -M $ref $file | gzip > $temp_sam; java -Xmx3G -jar $SORTSAMJAR I=$tempdir/temp.sam.gz O=$bam CREATE_INDEX=true SO=coordinate";
my $bwa_mem_cmd = "$BWA index $ref; echo; $BWA mem -t $cpu -M $ref $file | $samtools view -uS -| $samtools sort - $bam_prefix && $samtools index $bam";
print STDERR "Running command:\n$bwa_mem_cmd\n";
system($bwa_mem_cmd); # Run alignment
# print "Screen Output:$output\n";
print "\nDone Alignment\n\n";
}
# Create temporary fasta file of the sequences for this primerID.
my $temp_fasta = $tempdir."/temp.fa";
# Construct the command based on whether a reference fasta is provided or not.
# Note that this method can call an ambiguous residue in the consensus if there aren't very many reads
my $cmd = "";
if ($ref){
# $cmd = "$samtools mpileup -uf $ref $bam | bcftools view -cg - | vcfutils.pl vcf2fq | seqtk seq -A - > $temp_fasta";
}
else {
# $cmd = "$samtools mpileup -u $bam | bcftools view -cg - | vcfutils.pl vcf2fq | seqtk seq -A - > $temp_fasta";
$cmd = "$samtools mpileup -u $bam | $bcftools call -c | $vcfutils vcf2fq | $seqtk seq -A - > $temp_fasta";
}
# Run the command to create the consensus
print STDERR "Running command:\n$cmd\n";
my $output = `$cmd 2>&1`; # Captures STDERR and STDOUT
# Read the consensus fasta file.
my $in = Bio::SeqIO->new(-file => "$temp_fasta" ,
-format => 'Fasta'); # http://search.cpan.org/~cjfields/BioPerl-1.6.922/Bio/SeqIO.pm
my $seqobj = $in->next_seq();
$in = undef;
# Return consensus sequence
my $seq = uc( $seqobj->seq() );
if ($seq){
# Clean up intra-sample consensus sequence
$seq =~ s/^N+//ig; # Remove any trailing Ns.
$seq =~ s/N+$//ig;
print "Consensus seq: $seq\n";
return $seq;
}
else {
print STDERR "Unable to make intrasample consensus. Make sure samtools, bcftools, and seqtk are on your PATH.\nScreen output:\n$output\n";
exit;
}
}
#-----------------------------------------------------------------------------
sub convert_bam_to_fasta {
# This subroutine takes a bam file as input
# First step is to convert to fasta using bam2fastx from the tophat package. (or maybe fastq in the future if I want to add quality scores...)
# Do we still want to have the ability to set a minimum base quality, or should we just ignore this and take the fasta files as they are?
# If we want to be able to do this (essentially it converts the base to N so that it will not count towards a majority), then we need to keep quality information, so fastq or BAM.
# Otherwise, if we are requiring at least 3 or 5 reads per primerID group then majority rule might be sufficient to correct these things.
# But if there is a variant, we might want to look at the average quality of the bases to determine if it is real (like GATK and other variant callers...)
# Or maybe we validate the accuracy using alternative methods... but how?
# Email from Will:
# "Indeed, perhaps we should consider the quality score given their data, but you have a better feeling for that. We are already eliminating ambiguous calls – at least in the consensus. (right?)"
# Also, maybe use the bam file to get an intrapatient consensus to aid in the alignment... (except Will said don't use reference anymore to call consensus...what about ties? call ambiguous characters)
# If input file is fasta, no conversion is performed.
my $bam_file = shift;
# Convert BAM to Fasta
# E.g., bam2fastx -a -o Sample_5.concat.20K.primerid10bp.btrim.1.majority.fasta -A Sample_5.concat.20K.primerid10bp.btrim.1.majority.bam 2> /dev/null
my ($bam_prefix,$dir,$ext) = fileparse($bam_file,@suffixes);
# First check to see whether the input file has been converted to fasta already. Check based on the extension.
if ($ext =~ m/bam/i){ # < andrew
#if (1){ # < philip macmenamin
my $fasta = $save_dir . "/" . $bam_prefix . '.fasta';
my $cmd = "$bam2fastx_bin -a -o $fasta -A $bam_file 2> /dev/null";
print STDERR "Executing command to make fasta file: $cmd\n";
system($cmd);
return $fasta;
}
elsif($ext =~ m/(fa|fna|fasta|fas)$/i){
# Already Fasta file
print STDERR "Input file is FASTA format\n";
return $bam_file
}
else {
print STDERR "Unrecognized input format: $bam_file\n\tDoes your file have bam or fa/fna/fasta/fas as an extension?\n";
exit;
}
}
#-----------------------------------------------------------------------------
sub find_gap {
my $fasta = shift;
# Now read in the Fasta file and group the sequences by primerID.
my $apparent_long_gap_count = 0; # Number of reads found with a stretch of Ns >5. Sometimes the user might forget to set --gap and there are stretches of Ns in the middle. These will all be counted against the read as ambiguous unless --gap is set. Help the user out.
my $number_to_check = 1000; # Maximum number of sequences to read for getting gap size/location information
my %gap_sizes; # Save the gap sizes
my %gap_positions; # Save the gap positions
my $total = 0; # Total number of reads processed so far.
# my $min_auto_gap_size = 1; # parameterized this. Default will be 3.
my $in = Bio::SeqIO->new(-file => "$fasta" ,
-format => 'Fasta'); # http://search.cpan.org/~cjfields/BioPerl-1.6.922/Bio/SeqIO.pm
FASTA: while ( my $seqobj = $in->next_seq() ) {
# e.g.,
# >MISEQ:50:000000000-A4142:1:1101:10000:4300:ACGACTTGCA
# ATTCGAAAGATTCAAAATATTTCCCAAAGAAAGCTCATGGCCCGACCACAACACAAACGGAGTAACGGCAGCATGCTCCCATGAGGGGAAAAACAGTTTTTACAGAAATTTGCTATGGCTGACGAAGAAGGAGAGCTCATACCCAGAGCTGAAAAATTCTTATGTGAACAAAAAAAGGAAAGAAGTCCTTGTACTGTGGGGTATTCATCNNNNNNNTAACAGTAAGGAACAACAGGATCTCTATCAGAATGAAAATGCTTATGTCTCTGTAGTGACTTCAAATTATAACAGGAGATTTACCCCGGAAATAGCAGAAAGACCCAAAGTAAAAGGTCAAGCTGGGAGGATGAACTATTACTGGACCTTGCTAAAACCCGGAGACACAATAATATTTGAGGCAAATGGAAATCTAATAGCACCAATGTATGCTTTC
$total++;
my $seq = $seqobj->seq();
### Check for an internal stretch of Ns. Autodetect --gap and --R1_length
if ($apparent_long_gap_count < $number_to_check){ # Count all reads, or until 1000 reads are found with a gap. Could do more if desired.
if ($seq =~ m/(N+)/i){
my $length = length($1);
if ($length >= $min_auto_gap_size){ # Long gap set arbitrarily as 3xN. Could be parameterized... $min_auto_gap_size . changed default to 1xN. May want to parameterize it and then set default back to 3 to avoid random Ns in low-quality sequence, for example. Yes, I will do it.
$apparent_long_gap_count++;
$gap_sizes{$length}++;
my $pos = $-[0]; # Index. (In 1-based, this would be just before the first N)
$gap_positions{$pos}++;
# print STDERR "pos: $pos\tseq: $seq\n";
}
}
}
last FASTA if ($total >= $number_to_check);
}
# Now we read enough. Unset the SeqIO object and process the results of the gap
$in = undef;
# Process the gap sizes and positions and set/check --gap and --R1_length parameters.
my $fraction = 0;
$fraction = $apparent_long_gap_count / $total if ($total); # Fraction of the reads with a gap.
my $common_size = find_key_with_biggest_value(\%gap_sizes);
my $common_position = find_key_with_biggest_value(\%gap_positions);
if ($fraction > 0.2){ # Arbitrarily set to 20%. It will probably be close to 99% in reality.
printf STDERR "Many reads were found with a stretch of Ns >= $min_auto_gap_size ($total checked in total, found $apparent_long_gap_count).\nFraction of reads: %.3f\nMost common position: %2d (%.3f of reads with gap)\nMost common size: %2d (%.3f of reads with gap)\n", $fraction, $common_position, $gap_positions{$common_position}/$apparent_long_gap_count, $common_size, $gap_sizes{$common_size}/$apparent_long_gap_count;
my @gap_size_range = range([keys %gap_sizes]);
my @gap_pos_range = range([keys %gap_positions]);
# print join " ", @gap_size_range, "\n";
# print join " ", @gap_pos_range, "\n";
# print Dumper(\%gap_positions);
# print Dumper(\%gap_sizes);
my $earliest_pos = $gap_pos_range[0];
my $biggest_gap = $gap_size_range[1];
# If the user set 'auto' for $gap, $R1_length, or both, then provide values for those. Otherwise, provide warnings about their parameters as necessary.
if ($R1_length =~ m/auto/i && $gap =~ m/auto/i){ # Then we'll set both of these parameters for the user
if ($wide_gap){ # Wider gap
# If both parameters are using auto, we can set these to produce the widest possible gap
# Use the earliest position, and the largest stretch of Ns found for the gap size, starting from the latest position.
$R1_length = $earliest_pos;
$gap = $biggest_gap + ($gap_pos_range[1] - $gap_pos_range[0]);
}
else { # Default more conservative gap size.
$R1_length = $common_position;
$gap = $common_size;
}
}
elsif($gap =~ m/auto/i){ # User set $R1_length, probably similar to common_position (should we check?). Then we'll just set gap parameter for the user. Use something like the common_size
print STDERR "Setting --gap parameter to $common_size\n";
$gap = $common_size; # Good?
}
elsif($R1_length =~ m/auto/i){ # User set $gap but not R1_length. $gap will probably be a reasonable value. Set $R1_length for user.
print STDERR "Setting --R1_length parameter to $common_position\n";
$R1_length = $common_position; # Or should it be set based on their gap size?
}
else { # User set both parameters. Maybe suggest better values for the user.
if ($gap != $common_size){
print STDERR "WARNING: Most common gap size found was $common_size but $gap was used as input. You may want to change the gap size or use 'auto'.\n";
}
if ($R1_length != $common_position){
print STDERR "WARNING: Most common R1_length found was $common_position but $R1_length was used as input. You may want to change the R1_length size or use 'auto'.\n";
}
}
# Additional warning for when user sets --gap parameter that is smaller than auto-detected gap size
if ($gap < $common_size){
print STDERR "WARNING: Most common gap size found was $common_size but $gap was used as input. You may want to increase the gap size or use 'auto'.\n";
sleep 5;
}
}
else {
# Reads with a stretch of Ns >=5 represent a small fraction of the total reads analyzed so far (< 20%), so they are probably just sequencing errors, not an actual gap from concatenating reads.
# If the user set some parameters for --gap and --R1_length, then we can tell them that it's not likely that there is a gap actually.
# Or if 'auto' was set for either one, we can just set them both to 0. Don't worry about checking to see if they set a parameter for one but not the other; if either is set to zero, then it's as if both are set to zero.
if ($R1_length =~ m/auto/i || $gap =~ m/auto/i){ # The user set one or no parameters.
print STDERR "No significant gaps >= $min_auto_gap_size bp were detected in the reads. $total reads were processed and only $apparent_long_gap_count reads had a gap.\n";
($gap,$R1_length) = (0,0);
}
else{ # The user set both parameters, but we suggest they should reconsider
if ($gap >= $min_auto_gap_size){ # See if the user expected gaps >= $min_auto_gap_size bp long
print STDERR "No significant gaps >= $min_auto_gap_size bp were detected in the reads. $total reads were processed and only $apparent_long_gap_count reads had a gap.\n";
}
}
}
print STDERR "Using $R1_length and $gap as --R1_length and --gap settings, respectively.\n";
# sleep 5;
}
#-----------------------------------------------------------------------------
sub read_fasta {
# Next, group the reads by primerID (in the header) and then return this as a data structure.
my $fasta = shift;
my $read_tally; # HoHoA. First key is primerID, second key is 'sequence', value is array of sequences for alignment.
# Now read in the Fasta file and group the sequences by primerID.
my $total_reads = 0;
print STDERR "Grouping sequences by primerID.\n";
my $in = Bio::SeqIO->new(-file => "$fasta" ,
-format => 'Fasta'); # http://search.cpan.org/~cjfields/BioPerl-1.6.922/Bio/SeqIO.pm
while ( my $seqobj = $in->next_seq() ) {
# e.g.,
# >MISEQ:50:000000000-A4142:1:1101:10000:4300:ACGACTTGCA
# ATTCGAAAGATTCAAAATATTTCCCAAAGAAAGCTCATGGCCCGACCACAACACAAACGGAGTAACGGCAGCATGCTCCCATGAGGGGAAAAACAGTTTTTACAGAAATTTGCTATGGCTGACGAAGAAGGAGAGCTCATACCCAGAGCTGAAAAATTCTTATGTGAACAAAAAAAGGAAAGAAGTCCTTGTACTGTGGGGTATTCATCNNNNNNNTAACAGTAAGGAACAACAGGATCTCTATCAGAATGAAAATGCTTATGTCTCTGTAGTGACTTCAAATTATAACAGGAGATTTACCCCGGAAATAGCAGAAAGACCCAAAGTAAAAGGTCAAGCTGGGAGGATGAACTATTACTGGACCTTGCTAAAACCCGGAGACACAATAATATTTGAGGCAAATGGAAATCTAATAGCACCAATGTATGCTTTC
$total_reads++;
my $seq = $seqobj->seq();
my $id = $seqobj->display_id();
my @id = split(/:/, $id);
my $primerID = $id[-1];
warn "Primer ID doesn't look right: $primerID from id: $id\n" unless ($primerID =~ m/^[ACGT]+$/i); # Should N be allowed?
if ($primerID =~ m/N/i){
warn "Primer ID contains an N; skipping sequence\n";
next;
}
push @{$read_tally->{$primerID}->{sequence}}, $seq;
}
# Make a plot of counts by primerID group size
plot_counts($fasta, $read_tally) if ($plot_counts);
## Filter the data structure $read_tally at this point, removing entries for primerIDs that have fewer sequences than $min_reads or more than $max_reads.
# Adding this step here instead of filtering during the parallel loop in make_consensus seems to make the next step much faster. (about 26x speedup with my test file of 20K reads, albeit that removes most of the reads from the hash...)
# Also print out the reads that are less than --min_reads and greater than --max_reads to separate files. "belowmin" "abovemax"
my $too_few = 0; # Count for number of primerID groups < $min_reads
my $too_many = 0; # Count for number of primerID groups > $max_reads
my $just_right = 0; # Count for number of primerID groups within limits set.
my $total_groups = 0; # Count for all primerIDs groups.
# Prepare output files for reads below --min_reads and above --max_reads
my ($file_prefix,$dir,$ext) = fileparse($fasta,@suffixes);
my $belowmin_file = $save_dir . "/" . $file_prefix . ".belowmin.fasta";
my $abovemax_file = $save_dir . "/" . $file_prefix . ".abovemax.fasta";
unlink($belowmin_file) if (-e $belowmin_file);
unlink($abovemax_file) if (-e $abovemax_file);
foreach my $primerID (keys %$read_tally){
if (scalar(@{$read_tally->{$primerID}->{sequence}}) < $min_reads){
# Save to "belowmin" fasta file
print_out_of_range_fasta($belowmin_file,$primerID,$read_tally->{$primerID}->{sequence});
# Delete record
delete($read_tally->{$primerID});
$too_few++;
}
elsif($max_reads && scalar(@{$read_tally->{$primerID}->{sequence}}) > $max_reads){ # Check to see if $max_reads is defined, and if so, check to see whether
# Save to "abovemax" fasta file
print_out_of_range_fasta($abovemax_file,$primerID,$read_tally->{$primerID}->{sequence});
#Delete record
delete($read_tally->{$primerID});
$too_many++;
}
else {
$just_right++;
}
$total_groups++;
}
printf STDERR "Total primerID groups:\t%2d\n", $total_groups;
printf STDERR "primerID groups smaller than $min_reads removed:\t\t%i (%.3f)\n", $too_few, $too_few/$total_groups if ($too_few);
printf STDERR "primerID groups larger than $max_reads removed:\t\t%i (%.3f)\n", $too_many, $too_many/$total_groups if ($too_many);
printf STDERR "primerID groups retained for analysis:\t\t%i (%.3f)\n", $just_right, $just_right/$total_groups if ($just_right);
unless($just_right){
print STDERR "No PrimerID groups retained, exiting.\n";
&elapsed($start_time, 'Total', $verbose);
exit;
}
&elapsed($start_time, 'Elapsed', $verbose);
return $read_tally;
}
#-----------------------------------------------------------------------------
sub print_out_of_range_fasta {
my ($file,$primerID,$seq_array) = @_;
my $out_of_range_fh = open_to_write($file,0,">>"); # Open in append mode
my $j = 0; # count of seqs printed so far for this primerID group.
foreach my $seq (@$seq_array){
$j++;
print $out_of_range_fh ">$primerID"."-"."$j\n$seq\n";
}
close($out_of_range_fh);
}
#-----------------------------------------------------------------------------
sub plot_counts {
my ($fasta,$read_tally) = @_;
## Graph Primer ID group size distribution
# Before filtering the $read_tally data structure, make a graph of the primerID groups by number of reads per group, and then how many groups have that number.
# For now just make a simple barplot. Single sample. X-axis is "Counts in each PrimerID group" and Y-axis is fraction of Primer IDs
# It would be nice to make a summary plot with all samples in the workflow as well.
# So, I should make a temporary file that can be read into R and parsed later as well.
# Maybe make this optional in case a similar graph is produced by filter_fastq_by_primerid_length.pl.
my ($fasta_prefix,$dir,$ext) = fileparse($fasta,@suffixes);
my $group_count_file = $dir . $fasta_prefix . ".group.counts.txt";
my $group_count_graph = $dir . $fasta_prefix . ".group.counts.barplot.pdf";
my $group_counts; # Hashref to store the counts. keys, group size; value, number of primerID groups
foreach my $primer_id_group (keys %$read_tally){
my $number_in_this_group = scalar(@{$read_tally->{$primer_id_group}->{sequence}});
$group_counts->{$number_in_this_group}++;
}
my $total_primer_id_groups = scalar(keys %$read_tally);
my $count_fh = open_to_write($group_count_file);
print $count_fh "Reads_in_PrimerID_group\tNumber_of_groups\tFraction_of_groups\n";
foreach my $group_size (sort {$a <=> $b} keys %$group_counts){
printf $count_fh "%2d\t%2d\t%.3f\n", $group_size, $group_counts->{$group_size}, $group_counts->{$group_size} / $total_primer_id_groups;
}
close ($count_fh);
# Now graph this in R
my $R = Statistics::R->new(); # http://search.cpan.org/~fangly/Statistics-R-0.31/lib/Statistics/R.pm
my $out1 = $R->run(
"table <- read.delim(\"$group_count_file\")",
"ymax <- min(max(table\$Fraction_of_groups) * 1.25,1)", # In plot, change ylim to lesser value of (max Fraction_of_groups * 1.25 or 1) in case all values are ~0.2 or 0.1 (ymax of 1 is too high in that case so the plot doesn't look good)
"pdf(\"$group_count_graph\")",
"barplot(table\$Fraction_of_groups, names.arg=table\$Reads_in_PrimerID_group, ylim=c(0,ymax), ylab=\"Fraction of PrimerID Groups\", xlab=\"PrimerID Group Size (Number of Reads)\", main=\"PrimerID Group Size Distribution for $fasta_prefix\", cex.main=0.9)",
# "library(ggplot2)",
# "ggplot(table, aes(x = Reads_in_PrimerID_group, y = Fraction_of_groups)) + geom_bar(stat = \"identity\")", # Testing, so that I can add labels above the bars for the actual numbers
"dev.off()"
);
}
#-----------------------------------------------------------------------------
sub make_consensus {
# Maybe rename to reflect that we are aligning sequences...
# Takes read_tally HoHoA, aligns sequences for each barcode and calls a consensus by
# looking at the alignment, column by column.
my ($read_tally,$bam_file,$sample_consensus_seq) = @_; # $sample_consensus_seq will be empty if --tiebreaker is not specified.
# Prepare output files
my ($bam_prefix,$dir,$ext) = fileparse($bam_file,@suffixes);
my $out_file_good = $save_dir . "/" . $bam_prefix . '.cons.fasta';
my $out_file_ambig = $save_dir . "/" . $bam_prefix . '.ambig.fasta';
my @middle = ($R1_length + 1, $R1_length + $gap); # Start and stop of the internal gap, basically. If no gap, then these should both be zero. These are 1-based coordinates of the gap positions, inclusive. (check with a file that has no gap...)
# print Dumper(\@middle);exit;
print STDERR "Looking at groups of sequences to call a consensus for each primerID group.\n";
my $pl = Parallel::Loops->new($cpu);
my $count = 0;
# Beginning of parallel loop. See http://search.cpan.org/~pmorch/Parallel-Loops-0.03/lib/Parallel/Loops.pm
# Syntax: $pl->while($conditionSub, $childBodySub)
# Conceptually similar to
# while($conditionSub->()) {
# $childBodySub->();
# }
my $primerID = "";
my @primerIDs = keys %$read_tally;
# my $sequences; # AoA[oA]
# foreach my $key (keys %$read_tally){
# my $sequence; # arrayref
# $sequence->[0] = $key;
# $sequence->[1] = $read_tally->{$key}->{sequence};
# push @$sequences, $sequence;
# }
# print Dumper($sequences); #exit;
# Set up shared variables to store data.
my (@ambiguous,@good,@ambiguous_positions,@min_freq_positions); # arrays to save or count the number of primerid groups that are completely good or that have one or more ambiguous character. For @good and @ambiguous, each element is an arrayref with primerID and consensus sequence. @ambiguous_positions will have an array of all ambiguous positions found in the reads; this array can't be used to count the number of ambiguous sequences since some sequences will have multiple ambiguous sequences.
my @converted_base_counts; # Array to store the number of converted bases in each read. A "converted base" means the number of bases in a column in the alignment that differ from the consensus, assuming that the consensus is not an ambiguous character.
my @ambiguous_base_counts; # Array to store the number of bases that became an ambiguous nucleotide in the output due to lack of a majority consensus, or majority nucleotide fraction being below the --min_freq option.
my @total_base_counts; # Array to store the number of total bases in each read. This can serve as the denominator.
my @iupac_ambig_cons_counts; # Array to store the number of bases that are IUPAC ambiguous characters other than N in consensus reads
my @n_ambig_cons_counts; # Array to store the number of bases that are N in consensus reads
$pl->share(\@ambiguous, \@good, \@ambiguous_positions, \@min_freq_positions, \@converted_base_counts, \@ambiguous_base_counts, \@total_base_counts, \@iupac_ambig_cons_counts, \@n_ambig_cons_counts);
$pl->while( sub {$count++; $primerID = $primerIDs[$count - 1]; }, sub { # was $pl->foreach( \@primerIDs, sub {
# $primerID = $_;
# print "id: $primerID\n";
my @sequences = @{$read_tally->{$primerID}->{sequence}};
# if($verbose){ print Dumper(\@sequences); }
if ($count % 1000 == 0){
print STDERR "Processed $count primerID groups. ";
&elapsed($start_time, 'Elapsed', $verbose);
}
# Create temporary fasta file of the sequences for this primerID.
my $cwd = Cwd::cwd();
my $tempdir = File::Temp->newdir( "$temp_dir/fasta_file_".$count."_tempXXXXXX" );
my $temp_fasta = $tempdir."/temp.fa";
my $temp_aln = $tempdir."/temp.aln";
my $fh = open_to_write($temp_fasta, 0, 0, 1);
my $seq_count = 1; # sequence number within the primer id group
foreach my $sequence (@sequences){
print $fh ">$primerID-$seq_count\n$sequence\n";
$seq_count++;
}
# Add reference if needed for tiebreaker
if ($tiebreaker){
print $fh ">ref\n$sample_consensus_seq\n";
}
close($fh);
# if ($verbose){ system("cat $temp_fasta"); }
# Align with clustalw of mafft
my $aln;
if ($clustalw){
my $factory = Bio::Tools::Run::Alignment::Clustalw->new(-OUTORDER => "INPUT", -QUIET => 1, -QUICKTREE => 1, ); # -OUTORDER => "INPUT", -QUIET => 1, -QUICKTREE => 1
$aln = $factory->align("$temp_fasta"); # $aln is a SimpleAlign object. http://search.cpan.org/~cjfields/BioPerl-1.6.901/Bio/SimpleAlign.pm.
}
else {
# my $factory = Bio::Tools::Run::Alignment::MAFFT->new("-clustalout" => 1, "-quiet" => 1, ); # For some reason, it's ignoring these parameters...
# my $aln = $factory->align("$temp_fasta"); # $aln is a SimpleAlign object. http://search.cpan.org/~cjfields/BioPerl-1.6.901/Bio/SimpleAlign.pm.
my $cmd = "$mafft_bin --quiet --thread $cpu --op 1.4 $temp_fasta > $temp_aln"; # Default gap opening penalty 1.53 is a little too stringent sometimes. e.g.,
#>Seq12_part
#TTCGAAAGATTCAAAATATTT CCC AAA GAA AGC TCA TGG CCC GACCACAACACAACCGGAGTAACGGCAGCATGCTCCCATGAGGGGAAAAACAGTTTTTACAGAAATTTGCTATGGCTGACGAAGAAGGAGAGCTCATACCCAGAGCTGAAAAATTCTTATGTGAACAAAAAAAGGAAAGAAGTCCTTGTACTGTGGGGTATTCATCACCCGCCTAACAGTAAGGAACAACAGAATCTCTATCAGAATGAAAATGCTTATGTCTCTGTAGTGACTTCAAATTATAACAGGAGATTTACCCCGGAAATAGCAGAAAGACCCAAAGTAAAAGGTCAAGCTGGGAGGATGAACTATTACTGGACCTTGCTAAAACCCGGAGACACAATAATATTTGAGGCAAATGGAAATCTAATAGCACCAATGTATGCTTTC
#>GGAAAGACGG
#TTCGAAAGATTCAAAATATTT CCC AAA AA AGC TCA TGG GCCC GACCACAACACAAACGGAGTAACGGCAGCATGCTCCCATGAGGGGAAAAACAGTTTTTACAGAAATTTGCTATGGCTGACGAAGAAGGAGAGCTCATACCCAGAGCTGAAAAATTCTTATGTGAACAAAAAAAGGAAAGAAGTCCTTGTACTGTGGGGTATTCATCNNNNNNNTAACAGTAAGGAACAACAGAATCTCTATCAGAATGAAAATGCTTATGTCTCTGTAGTGACTTCAAATTATAACAGGAGATTTACCCCGGAAATAGCAGAAAGACCCAAAGTAAAAGGTCAAGCTGGGAGGATGAACTATTACTGGACCTTGCTAAAACCCGGAGACACAATAATATTTGAGGCAAATGGAAATCTAATAGCACCAATGTATGCTTTC
system($cmd);
my $aln_in = Bio::AlignIO->new(
-file => $temp_aln,
-format => 'fasta',
);
$aln = $aln_in->next_aln();
}
my $seqIO = Bio::AlignIO->new(-fh => \*STDERR, -format => 'clustalw');
if ($verbose){ print "ALIGNMENT: \n"; $seqIO->write_aln($aln); }
# Save the aligned reference and them remove from the alignment if $tiebreaker is set. See http://search.cpan.org/~cjfields/BioPerl-1.6.923/Bio/Align/AlignI.pm
my $aligned_ref_seq = "";
if ($tiebreaker){
# $seqIO->write_aln($aln); # Before removing ref
my @seqs = $aln->each_seq_with_id("ref"); # Array of seq objects containing ref only
my $aligned_ref_locatable_seq_obj = shift(@seqs); # Bio::LocatableSeq object with aligned reference sequence
$aligned_ref_seq = $aligned_ref_locatable_seq_obj->seq(); # aligned reference sequence. Same positions as the aligned reads.
# print STDERR "reference: $aligned_ref_seq\n";
$aln->remove_seq($aligned_ref_locatable_seq_obj); # alignment of reads only, without reference.
# $seqIO->write_aln($aln); # After removing ref
}
# Walk through the alignment column by column
my $len = $aln->length();
my @cons_seq; # Consensus sequence for this primerID group
my $ambig_pos; # Hashref of ambiguous positions where key is position and value is an AoA of the tied bases and their counts.
my $nongap_ambig_count = 0;
my $ambig_summary_for_fasta_header_def = ""; # String to add to fasta header after the primerID. positions and ambiguous characters that were found outside of the gap. Helpful for understanding why a read was put in the ambig fasta file.
my $total_base_count = 0; # Use to store the number of total bases seen in the alignment, to be saved to @total_base_counts after reviewing all columns in the alignment. Don't include gap characters; only ACTGN
my $total_converted_base_count = 0; # Use to store the number of total bases that differ from the consensus in columns passing min_freq. To be saved to @converted_base_counts
my $total_ambig_base_count = 0; # Use to store the number of total bases in columns where the no consensus is called due to not passing min_freq or no clear majority. To be saved to @ambiguous_base_counts.
my $total_iupac_ambig_in_consensus = 0; # Use to store the number of bases that are iupac characters (other than N) in the consensus read
my $total_n_ambig_in_consensus = 0; # Use this to store the number of bases that are N in the consensus read
my $res_num = 1; # Residue number. This is the position of the residue within the final consensus sequence.
my @this_min_freq_positions;
for (my $pos = 1; $pos <= $len; $pos++){ # $pos is the position in the alignment. It is usually the same as $res_num, residue number, except when there is an indel (-)
my %count;
foreach my $seq ($aln->each_seq() ) { # Looking at each base in the column, counting up the bases.
#http://search.cpan.org/~cjfields/BioPerl-1.6.901/Bio/SimpleAlign.pm
my $res = $seq->subseq($pos, $pos);
$count{$res}++;
}
my $this_column_base_count = 0;
foreach my $res (keys %count) {
# if($verbose){ printf "Pos: %2d Res: %s Count: %2d\n", $pos, $res, $count{$res}; }
$this_column_base_count += $count{$res} if ($res =~ m/[ACTGN]/i); # Count all real bases in the column. Don't count gaps.
}
$total_base_count += $this_column_base_count;
my ($max_key_value) = find_key_with_biggest_value(\%count,2,1); # returns arrayref of results, including ties
# if($verbose){ if (scalar(keys %count)>1){ my $top = find_key_with_biggest_value(\%count); printf "Pos: %2d Res: %s Count: %2d\n", $pos, $top, $count{$top}; } }
my $res = "";
if (scalar(@$max_key_value) > 1){
# Then there is an ambiguous base because it couldn't be decided on a winner
$ambig_pos->{$res_num}=$max_key_value; # Store the AoA of residue counts, to keep track of residue position. Could this be overwriting values if $res_num is the same for multiple columns?
#$VAR1 = [
# [
# 'T',
# 2
# ],
# [
# 'C',
# 2
# ]
# ];
if ($tiebreaker){
# Assign sample consensus residue
$res = substr($aligned_ref_seq, $pos - 1, 1); # Check is it right? yes, it's getting the right base, even with a gap.
if ($verbose){ print STDERR "assign sample cons: $pos, $res\n"; }
$total_converted_base_count += tally_nonconsensus_bases(\%count, $res);
}
else {
# Assign ambiguous IUPAC residue or N
my @ambig_res; # Array of the nucleotide residues that tied for maximum.
foreach(@$max_key_value){
push @ambig_res, $_->[0];
}
my $ambig_res = join "", sort @ambig_res; # Join the two or more residues to get IUPAC consensus
if ($ambig_res =~ m/[N\.-]/i){ # ambiguities with Ns or gaps are assigned as "N" (?)
if ($debug){ print STDERR "An ambiguous base with N, '.' or '-'\tPos: $res_num\n"; }
$res = "N";
$total_n_ambig_in_consensus++;
}
else {
# Max residues do not include N. Get IUPAC ambiguous base.
if ($debug){ print STDERR "An ambiguous base with $ambig_res\tPos: $res_num\n"; }
$res = $iupac->{$ambig_res};
$total_iupac_ambig_in_consensus++;
}
# $ambig_summary_for_fasta_header_def .= " " . $res_num . uc($res); # add the position and resulting ambiguous character to the fasta header. Do below instead...
$total_ambig_base_count += $this_column_base_count; # Assign all of the bases in this column ($total_base_count) to the $total_ambig_base_count
}
}
else {
# Then there is a clear majority for one base.
$res = $max_key_value->[0]->[0]; # If there is a clear winner, this will work. Note that this can sometimes be an N, which we need to check.
# Also check frequency. By default, a basic "majority rule" is in effect. This is an additional filter that will require that the frequency for the majority is above a certain threshold, e.g., 2/3
my $max_freq = $max_key_value->[0]->[1] / total(values %count);
if ($min_freq && $max_freq < $min_freq){
# Then there was a clear majority, but the frequency didn't pass $min_freq. Assign ambiguous
$res = "N"; # assign ambiguous. Maybe this should be smarter, to assign ambiguity based on the bases that were seen...
push @this_min_freq_positions, $res_num;
$total_ambig_base_count += $this_column_base_count; # Assign all of the bases in this column ($total_base_count) to the $total_ambig_base_count
$total_n_ambig_in_consensus++;
}
else {
# $res is clear majority, and also passing min_freq.
$total_converted_base_count += tally_nonconsensus_bases(\%count, $res);
}
}
unless($res){
# Then something's wrong
warn "Residue has no value...\n";
print STDERR Dumper($max_key_value);
}
# If the base is ambiguous or N and OUTSIDE of the gap region (between concatenated reads), flag this column as ambiguous.
# If --tiebreaker is set, then the ambiguous base above will be overwritten by the sample consensus base, so it shouldn't be flagged as ambiguous.
if ($res =~ m/[NMRWSYKVHDB]/i){ # ambiguous bases OR Ns from gap
unless ( $gap && (($res_num >= $middle[0]) && ($res_num <= $middle[1])) ){ # If the "N" residue is found in the middle gap created by concatenating two reads together, then it is not counted against the read as an ambiguous base. Only check this if $gap is defined. Otherwise, all Ns are treated as ambiguous bases.
# print STDERR "nongap_ambig at position $res_num\n";
$nongap_ambig_count++; # The ambiguous residue is found outside of the gap, so counts against the read.
$ambig_summary_for_fasta_header_def .= " " . $res_num . uc($res);
# if ($debug){
# $seqIO->write_aln($aln);
# }
}
# But what if we find a non-N ambiguous base inside the middle gap region...
# This could happen if the gap for this pair is a little smaller than expected
# Should I set a flag/warning for this?
if ($gap && $res =~ m/[MRWSYKVHDB]/i && (($res_num >= $middle[0]) && ($res_num <= $middle[1])) ){ # non-N ambiguous character found in the gap!
print STDERR "Non-N Ambiguous base $res found at position $res_num in the middle gap (gap from $middle[0] to $middle[1]) for id: $primerID. Not treated as ambiguous. The --gap parameter may be too wide.\n";
}
}
# Save the residue to the consensus sequence array
push @cons_seq, $res;
if ($debug){
if (scalar(@$max_key_value) > 1){ # If true, then there is an ambiguous base.
# $seqIO->write_aln($aln);
print STDERR "id: $primerID\tPos: $res_num\n";
# print STDERR "Max key(s), value:\n";
# print STDERR Dumper($max_key_value);
}
}
$res_num++ unless ($res =~ m/-/); # Residues that have a gap as a consensus (non-ambiguous) are usually indels. They shouldn't be assigned a position in the final consensus sequence.
} # Done reading each position in the alignment
# exit if ($primerID eq "GTGTCCAGGC"); # This was for testing on a primerID group with an insertion in one of the sequences.
# Concatenate the bases to make the consensus sequence.
my $cons_seq = join "", @cons_seq;
# Check for any gaps, then collapse gaps
if ($cons_seq =~ m/[-\.]/ && $verbose){
# Then there was a gap in the consensus. This could either be a real deletion, or else one of the reads had an insertion/homopolymer that the other reads did not have.
my $gap_pos = $-[0]+1;
# print STDERR "Gap in consensus at position $gap_pos for id: $primerID\nconsensus: $cons_seq\n";
}
$cons_seq =~ s/[-\.]//g; # Delete any gaps in the consensus.
# Deal with ambiguous positions/reads (if any)
my @ambig_pos = keys %$ambig_pos;
my $id = $primerID . $ambig_summary_for_fasta_header_def;
my @id_seq = ($id, $cons_seq);
if ($nongap_ambig_count <= $ambig){
# Then report/save read
push @good, \@id_seq; # Increment the good kept read count
}
else {
if ($debug){
# print STDERR "Too many ambiguities ($nongap_ambig_count) in sequence (id $primerID): $cons_seq\n";
# $seqIO->write_aln($aln);
# print STDERR "gap range: $middle[0] to $middle[1]\n";
print STDERR "ambiguous positions: ";
print STDERR join " ", @ambig_pos, "\n";
print STDERR Dumper($ambig_pos);
}
push @ambiguous, \@id_seq; # Increment the ambiguous tossed read count
}
push @ambiguous_positions, @ambig_pos; # Add the whole array of ambiguous positions to the shared array of ambiguous positions
push @min_freq_positions, \@this_min_freq_positions; # Add arrayref of nucleotide positions where an ambiguous base was called because the maximum base called was less than --min_freq
# Save the base counts (total, converted, ambig) to their respective arrays
push @total_base_counts, $total_base_count;
push @converted_base_counts, $total_converted_base_count;
push @ambiguous_base_counts, $total_ambig_base_count;
push @iupac_ambig_cons_counts, $total_iupac_ambig_in_consensus;
push @n_ambig_cons_counts, $total_n_ambig_in_consensus;