Bio/AlignIO/mega.pm

filter: Statementstmt 94.5% 87 / 92 Branchbran 77.7% 28 / 36 Conditioncond 33.3% 3 / 9 MC/DCmcdc 0.0% 0 / 6 Subroutinesub 100% 8 / 8 Podpod 100% 2 / 2 totaltotal 83.6% 128 / 153 CC 26 SCAR 25.3
CC
26
Cov
86%
next_aln
17.5
write_aln
11.4
BEGIN
1.0
CRAP 12.6
« Bio/Seq/Meta/Array.pm ↑ Summary Bio/AlignIO/maf.pm »
1 #
2 # BioPerl module for Bio::AlignIO::mega
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Jason Stajich <jason-at-bioperl.org>
7 #
8 # Copyright Jason Stajich
9 #
10 # You may distribute this module under the same terms as perl itself
11  
12 # POD documentation - main docs before the code
13  
14 =head1 NAME
15  
16 Bio::AlignIO::mega - Parse and Create MEGA format data files
17  
18 =head1 SYNOPSIS
19  
20 use Bio::AlignIO;
21 my $alignio = Bio::AlignIO->new(-format => 'mega',
22 -file => 't/data/hemoglobinA.meg');
23  
24 while( my $aln = $alignio->next_aln ) {
25 # process each alignment or convert to another format like NEXUS
26 }
27  
28 =head1 DESCRIPTION
29  
30 This object handles reading and writing data streams in the MEGA
31 format (Kumar and Nei).
32  
33  
34 =head1 FEEDBACK
35  
36 =head2 Mailing Lists
37  
38 User feedback is an integral part of the evolution of this and other
39 Bioperl modules. Send your comments and suggestions preferably to
40 the Bioperl mailing list. Your participation is much appreciated.
41  
42 bioperl-l@bioperl.org - General discussion
43 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
44  
45 =head2 Support
46  
47 Please direct usage questions or support issues to the mailing list:
48  
49 I<bioperl-l@bioperl.org>
50  
51 rather than to the module maintainer directly. Many experienced and
52 reponsive experts will be able look at the problem and quickly
53 address it. Please include a thorough description of the problem
54 with code and data examples if at all possible.
55  
56 =head2 Reporting Bugs
57  
58 Report bugs to the Bioperl bug tracking system to help us keep track
59 of the bugs and their resolution. Bug reports can be submitted the
60 web:
61  
62 https://github.com/bioperl/bioperl-live/issues
63  
64 =head1 AUTHOR - Jason Stajich
65  
66 Email jason-at-bioperl.org
67  
68 =head1 APPENDIX
69  
70 The rest of the documentation details each of the object methods.
71 Internal methods are usually preceded with a _
72  
73 =cut
74  
75  
76 # Let the code begin...
77  
78  
79 package Bio::AlignIO::mega;
80 2 $Bio::AlignIO::mega::VERSION = '1.7.8';
81 2 ▶use vars qw($MEGANAMELEN %VALID_TYPES $LINELEN $BLOCKLEN);
Subroutine BEGIN: called CC=1 SCAR=0.0
82 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
83  
84 2 ▶use Bio::SimpleAlign;
Subroutine BEGIN: called CC=1 SCAR=0.0
85 2 ▶use Bio::LocatableSeq;
Subroutine BEGIN: called CC=1 SCAR=0.0
86  
87 # symbols are changed due to MEGA's use of '.' for redundant sequences
88  
89 2 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
90 2 $MEGANAMELEN = 10;
91 2 $LINELEN = 60;
92 2 $BLOCKLEN = 10;
93 2 %VALID_TYPES = map {$_, 1} qw( dna rna protein standard);
94 }
95 2 ▶use base qw(Bio::AlignIO);
Subroutine BEGIN: called CC=1 SCAR=0.0
96  
97  
98 =head2 next_aln
99  
100 Title : next_aln
101 Usage : $aln = $stream->next_aln()
102 Function: returns the next alignment in the stream.
103 Supports the following MEGA format features:
104 - The file has to start with '#mega'
105 - Reads in the name of the alignment from a comment
106 (anything after '!TITLE: ') .
107 - Reads in the format parameters datatype
108  
109 Returns : L<Bio::Align::AlignI> object - returns 0 on end of file
110 or on error
111 Args : NONE
112  
113  
114 =cut
115  
116 1 ▶sub next_aln{
Subroutine next_aln: called CC=17 SCAR=28.6
Pod documented
117 1 my ($self) = @_;
118 1 my $entry;
119 1 my ($alphabet,%seqs);
120 1 local $Bio::LocatableSeq::OTHER_SYMBOLS = '\*\?\.';
121 1 local $Bio::LocatableSeq::GAP_SYMBOLS = '\-';
122 1 my $aln = Bio::SimpleAlign->new(-source => 'mega');
123  
124 1 ▶ while( defined($entry = $self->_readline()) && ($entry =~ /^\s+$/) ) {}
Branch: 1 branch
BranchTrueFalseTotal
if (defined($entry = $self->_readline) and $entry =~ /^\s+$/) 0 1 1
Condition33%1/3
defined($entry = $self->_readline) and $entry =~ /^\s+$/
!ll&&!rl&&r
010
MC/DC0%0/2
defined($entry = $self->_readline) and $entry =~ /^\s+$/
defined($entry = $self->_readline) $entry =~ /^\s+$/
Truth table33%1/3
A and B
A= defined($entry = $self->_readline)B= $entry =~ /^\s+$/
ABresult
0X0
100
111
125  
126 1 ▶ $self->throw("Not a valid MEGA file! [#mega] not starting the file!")
Branch: 1 branch
BranchTrueFalseTotal
unless $entry =~ /^#mega/i 0 1 1
127 unless $entry =~ /^#mega/i;
128  
129 1 ▶ while( defined($entry = $self->_readline() ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($entry = $self->_readline)) 12 0 12
130 12 local($_) = $entry;
131 12 ▶ if(/\!Title:\s*([^\;]+)\s*/i) { $aln->id($1)}
Branch: 3 branches
BranchTrueFalseTotal
if (/\!Title:\s*([^\;]+)\s*/i) { } 1 11 12
elsif (s/\!Format\s+([^\;]+)\s*/$1/) { } 1 10 11
elsif (/^\#/) { } 1 9 10
132 elsif( s/\!Format\s+([^\;]+)\s*/$1/ ) {
133 1 my (@fields) = split(/\s+/,$1);
134 1 foreach my $f ( @fields ) {
135 3 my ($name,$value) = split(/\=/,$f);
136 3 ▶ if( $name eq 'datatype' ) {
Branch: 3 branches
BranchTrueFalseTotal
if ($name eq 'datatype') { } 1 2 3
elsif ($name eq 'identical') { } 1 1 2
elsif ($name eq 'indel') { } 1 0 1
137 1 $alphabet = $value;
138 } elsif( $name eq 'identical' ) {
139 1 $aln->match_char($value);
140 } elsif( $name eq 'indel' ) {
141 1 $aln->gap_char($value);
142 }
143 }
144 } elsif( /^\#/ ) {
145 1 last;
146 }
147 }
148 1 my @order;
149 1 ▶ while( defined($entry) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $entry) 21 1 22
150 21 ▶ if( $entry !~ /^\s+$/ ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($entry =~ /^\s+$/) 18 3 21
151 # this is to skip the leading '#'
152 18 my $seqname = substr($entry,1,$MEGANAMELEN-1);
153 18 $seqname =~ s/(\S+)\s+$/$1/g;
154 18 my $line = substr($entry,$MEGANAMELEN);
155 18 $line =~ s/\s+//g;
156 18 ▶ if( ! defined $seqs{$seqname} ) {push @order, $seqname; }
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $seqs{$seqname}) 6 12 18
157 18 $seqs{$seqname} .= $line;
158 }
159 21 $entry = $self->_readline();
160 }
161  
162 1 foreach my $seqname ( @order ) {
163 6 my $s = $seqs{$seqname};
164 6 $s =~ s/[$Bio::LocatableSeq::GAP_SYMBOLS]+//g;
165 6 my $end = length($s);
166 my $seq = Bio::LocatableSeq->new('-alphabet' => $alphabet,
167 '-display_id' => $seqname,
168 6 '-seq' => $seqs{$seqname},
169 '-start' => 1,
170 '-end' => $end);
171  
172 6 $aln->add_seq($seq);
173 }
174 1 $aln->unmatch;
175 1 ▶ return $aln if $aln->num_sequences;
Branch: 1 branch
BranchTrueFalseTotal
if $aln->num_sequences 1 0 1
176 0 return;
177 }
178  
179 =head2 write_aln
180  
181 Title : write_aln
182 Usage : $stream->write_aln(@aln)
183 Function: writes the $aln object into the stream in MEGA format
184 Returns : 1 for success and 0 for error
185 Args : L<Bio::Align::AlignI> object
186  
187 =cut
188  
189 1 ▶sub write_aln{
Subroutine write_aln: called CC=10 SCAR=24.3
Pod documented
190 1 my ($self,@aln) = @_;
191 1 my $count = 0;
192 1 my $wrapped = 0;
193 1 my $maxname;
194  
195 1 foreach my $aln ( @aln ) {
196 1 ▶ if( ! $aln || ! $aln->isa('Bio::Align::AlignI') ) {
Branch: 2 branches
BranchTrueFalseTotal
if (not $aln && $aln->isa('Bio::Align::AlignI')) { } 0 1 1
elsif (not $aln->is_flush($self->verbose)) { } 0 1 1
Condition33%1/3
$aln && $aln->isa('Bio::Align::AlignI')
!ll&&!rl&&r
001
MC/DC0%0/2
$aln && $aln->isa('Bio::Align::AlignI')
$aln $aln->isa('Bio::Align::AlignI')
Truth table33%1/3
A && B
A= $alnB= $aln->isa('Bio::Align::AlignI')
ABresult
0X0
100
111
197 0 $self->warn("Must provide a Bio::Align::AlignI object when calling write_aln");
198 0 return 0;
199 } elsif( ! $aln->is_flush($self->verbose) ) {
200 0 $self->warn("All Sequences in the alignment must be the same length");
201 0 return 0;
202 }
203 1 $aln->match();
204 1 my $len = $aln->length();
205 1 my $format = sprintf('datatype=%s identical=%s indel=%s;',
206 $aln->get_seq_by_pos(1)->alphabet(),
207 $aln->match_char, $aln->gap_char);
208  
209 1 $self->_print(sprintf("#mega\n!Title: %s;\n!Format %s\n\n\n",
210 $aln->id, $format));
211  
212 1 my ($count, $blockcount,$length) = ( 0,0,$aln->length());
213 1 $aln->set_displayname_flat();
214 1 ▶ while( $count < $length ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($count < $length) 3 1 4
215 3 foreach my $seq ( $aln->each_seq ) {
216 18 my $seqchars = $seq->seq();
217 18 $blockcount = 0;
218 18 my $substring = substr($seqchars, $count, $LINELEN);
219 18 my @blocks;
220 18 ▶ while( $blockcount < length($substring) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($blockcount < length $substring) 90 18 108
221 90 push @blocks, substr($substring, $blockcount,$BLOCKLEN);
222 90 $blockcount += $BLOCKLEN;
223 }
224 18 $self->_print(sprintf("#%-".($MEGANAMELEN-1)."s%s\n",
225 substr($aln->displayname($seq->get_nse()),
226 0,$MEGANAMELEN-2),
227 join(' ', @blocks)));
228 }
229 3 $self->_print("\n");
230 3 $count += $LINELEN;
231 }
232 }
233 1 ▶ $self->flush if $self->_flush_on_write && defined $self->_fh;
Branch: 1 branch
BranchTrueFalseTotal
if $self->_flush_on_write and defined $self->_fh 1 0 1
Condition33%1/3
$self->_flush_on_write and defined $self->_fh
!ll&&!rl&&r
001
MC/DC0%0/2
$self->_flush_on_write and defined $self->_fh
$self->_flush_on_write defined $self->_fh
Truth table33%1/3
A and B
A= $self->_flush_on_writeB= defined $self->_fh
ABresult
0X0
100
111
234 1 return 1;
235 }
236  
237  
238 2 1;
« Bio/Seq/Meta/Array.pm ↑ Summary Bio/AlignIO/maf.pm »