Bio/SearchIO/sim4.pm

filter: Statementstmt 84.6% 177 / 209 Branchbran 71.5% 83 / 116 Conditioncond 44.4% 24 / 54 MC/DCmcdc 23.5% 8 / 34 Subroutinesub 77.7% 14 / 18 Podpod 91.6% 11 / 12 totaltotal 71.5% 317 / 443 CC 82 SCAR 37.6
CC
82
Cov
75%
next_result
71.6
within_element
42.0
end_element
22.8
CRAP 42.8
« Bio/SearchIO/rnamotif.pm ↑ Summary Bio/PrimarySeqI.pm »
1 #
2 # BioPerl module for Bio::SearchIO::sim4
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Jason Stajich <jason-at-bioperl-dot-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::SearchIO::sim4 - parser for Sim4 alignments
17  
18 =head1 SYNOPSIS
19  
20 # do not use this module directly, it is a driver for SearchIO
21 use Bio::SearchIO;
22 my $searchio = Bio::SearchIO->new(-file => 'results.sim4',
23 -format => 'sim4');
24  
25 while ( my $result = $searchio->next_result ) {
26 while ( my $hit = $result->next_hit ) {
27 while ( my $hsp = $hit->next_hsp ) {
28 # ...
29 }
30 }
31 }
32  
33 =head1 DESCRIPTION
34  
35 This is a driver for the SearchIO system for parsing Sim4.
36 http://globin.cse.psu.edu/html/docs/sim4.html
37  
38 Cannot parse LAV or 'exon file' formats (A=2 or A=5)
39  
40 =head1 FEEDBACK
41  
42 =head2 Mailing Lists
43  
44 User feedback is an integral part of the evolution of this and other
45 Bioperl modules. Send your comments and suggestions preferably to
46 the Bioperl mailing list. Your participation is much appreciated.
47  
48 bioperl-l@bioperl.org - General discussion
49 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
50  
51 =head2 Support
52  
53 Please direct usage questions or support issues to the mailing list:
54  
55 I<bioperl-l@bioperl.org>
56  
57 rather than to the module maintainer directly. Many experienced and
58 reponsive experts will be able look at the problem and quickly
59 address it. Please include a thorough description of the problem
60 with code and data examples if at all possible.
61  
62 =head2 Reporting Bugs
63  
64 Report bugs to the Bioperl bug tracking system to help us keep track
65 of the bugs and their resolution. Bug reports can be submitted via the
66 web:
67  
68 https://github.com/bioperl/bioperl-live/issues
69  
70 =head1 AUTHOR - Jason Stajich
71  
72 Email jason-at-bioperl-dot-org
73  
74 =head1 CONTRIBUTORS
75  
76 Luc Gauthier (lgauthie@hotmail.com)
77  
78 =head1 APPENDIX
79  
80 The rest of the documentation details each of the object methods.
81 Internal methods are usually preceded with a _
82  
83 =cut
84  
85  
86 # Let the code begin...
87  
88  
89 package Bio::SearchIO::sim4;
90 2 $Bio::SearchIO::sim4::VERSION = '1.7.8';
91 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
92 2 ▶use vars qw($DEFAULTFORMAT %ALIGN_TYPES
Subroutine BEGIN: called CC=1 SCAR=0.0
93 2 %MAPPING %MODEMAP $DEFAULT_WRITER_CLASS);
94  
95 2 ▶use POSIX;
Subroutine BEGIN: called CC=1 SCAR=0.0
96 2 ▶use Bio::SearchIO::SearchResultEventBuilder;
Subroutine BEGIN: called CC=1 SCAR=0.0
97  
98 2 ▶use base qw(Bio::SearchIO);
Subroutine BEGIN: called CC=1 SCAR=0.0
99  
100 2 $DEFAULTFORMAT = 'SIM4';
101 2 $DEFAULT_WRITER_CLASS = 'Bio::SearchIO::Writer::HitTableWriter';
102  
103 2 %ALIGN_TYPES = (
104 0 => 'Ruler',
105 1 => 'Query',
106 2 => 'Mid',
107 3 => 'Sbjct'
108 );
109  
110 2 %MODEMAP = (
111 'Sim4Output' => 'result',
112 'Hit' => 'hit',
113 'Hsp' => 'hsp'
114 );
115  
116 2 %MAPPING = (
117 'Hsp_query-from'=> 'HSP-query_start',
118 'Hsp_query-to' => 'HSP-query_end',
119 'Hsp_qseq' => 'HSP-query_seq',
120 'Hsp_qlength' => 'HSP-query_length',
121 'Hsp_querygaps' => 'HSP-query_gaps',
122 'Hsp_hit-from' => 'HSP-hit_start',
123 'Hsp_hit-to' => 'HSP-hit_end',
124 'Hsp_hseq' => 'HSP-hit_seq',
125 'Hsp_hlength' => 'HSP-hit_length',
126 'Hsp_hitgaps' => 'HSP-hit_gaps',
127 'Hsp_midline' => 'HSP-homology_seq',
128 'Hsp_score' => 'HSP-score',
129 'Hsp_align-len' => 'HSP-hsp_length',
130 'Hsp_identity' => 'HSP-identical',
131  
132 'Hit_id' => 'HIT-name',
133 'Hit_desc' => 'HIT-description',
134 'Hit_len' => 'HIT-length',
135  
136 'Sim4Output_program' => 'RESULT-algorithm_name',
137 'Sim4Output_query-def' => 'RESULT-query_name',
138 'Sim4Output_query-desc'=> 'RESULT-query_description',
139 'Sim4Output_query-len' => 'RESULT-query_length',
140 );
141  
142  
143  
144 =head2 new
145  
146 Title : new
147 Usage : my $obj = Bio::SearchIO::sim4->new();
148 Function: Builds a new Bio::SearchIO::sim4 object
149 Returns : an instance of Bio::SearchIO::sim4
150 Args :
151  
152  
153 =cut
154  
155  
156 =head2 next_result
157  
158 Title : next_result
159 Usage : my $result = $searchio->next_result;
160 Function: Returns the next Result from a search
161 Returns : Bio::Search::Result::ResultI object
162 Args : none
163  
164 =cut
165  
166 6 ▶sub next_result {
Subroutine next_result: called CC=49 SCAR=42.7
Pod documented
167 6 my ($self) = @_;
168 6 local $/ = "\n";
169 6 local $_;
170  
171 # Declare/adjust needed variables
172 6 $self->{'_last_data'} = '';
173 6 my ($seentop, $qfull, @hsps, %alignment, $format);
174 6 my $hit_direction = 1;
175  
176 # Start document and main element
177 6 $self->start_document();
178 6 $self->start_element({'Name' => 'Sim4Output'});
179 6 my $lastquery = '';
180 # Read output report until EOF
181 6 ▶ while( defined($_ = $self->_readline) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($_ = $self->_readline)) 72 6 78
182 # Skip empty lines, chomp filled ones
183 72 ▶ next if( /^\s+$/); chomp;
Branch: 1 branch
BranchTrueFalseTotal
if /^\s+$/ 18 54 72
184  
185 # Make sure sim4 output format is not 2 or 5
186 54 ▶ if (!$seentop) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($seentop) 6 48 54
187 0 ▶ if ( /^\#:lav/ ) { $format = 2; }
Branch: 2 branches
BranchTrueFalseTotal
if (/^\#:lav/) { } 0 6 6
elsif (/^<|>/) { } 0 6 6
188 0 elsif ( /^<|>/ ) { $format = 5; }
189 6 ▶ $self->throw("Bio::SearchIO::sim4 module cannot parse 'type $format' outputs.") if $format;
Branch: 1 branch
BranchTrueFalseTotal
if $format 0 6 6
190 }
191  
192 # This line indicates the start of a new hit
193 54 ▶ if( /^seq1\s*=\s*(\S+),\s+(\d+)/ ) {
Branch: 6 branches
BranchTrueFalseTotal
if (/^seq1\s*=\s*(\S+),\s+(\d+)/) { } 7 47 54
elsif (/^seq2\s*=\s*(\S+)\s+\(>?(\S+)\s*\),\s*(\d+)/) { } 7 40 47
elsif (/^>(\S+)\s*(.*)?/) { } 2 38 40
elsif (/^\(complement\)/) { } 2 36 38
elsif (/^\(?(\d+)\-(\d+)\)?\s+\(?(\d+)\-(\d+)\)?\s+(\d+)/) { } 28 8 36
elsif (/^\s+(\d+)\s/) { } 8 0 8
194 7 my ($nm,$desc) = ($1,$2);
195 # First hit? Adjust some parameters if so
196 7 ▶ if ( ! $seentop ) {
Branch: 2 branches
BranchTrueFalseTotal
if (not $seentop) { } 6 1 7
elsif ($nm ne $lastquery) { } 0 1 1
197 6 $self->element( {'Name' => 'Sim4Output_query-def',
198 'Data' => $nm} );
199 6 $self->element( {'Name' => 'Sim4Output_query-len',
200 'Data' => $desc} );
201 6 $seentop = 1;
202 } elsif( $nm ne $lastquery ) {
203 0 $self->_pushback($_);
204 0 last;
205 }
206 7 $lastquery = $nm;
207 # A previous HSP may need to be ended
208 7 ▶ $self->end_element({'Name' => 'Hsp'}) if ( $self->in_element('hsp') );
Branch: 1 branch
BranchTrueFalseTotal
if $self->in_element("hsp") 0 7 7
209 # A previous hit exists? End it and reset needed variables
210 7 ▶ if ( $self->in_element('hit') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->in_element("hit")) 1 6 7
211 1 foreach (@hsps) {
212 4 $self->start_element({'Name' => 'Hsp'});
213 4 ▶ while (my ($name, $data) = each %$_) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %$_) 32 4 36
214 32 $self->{'_currentHSP'}{$name} = $data;
215 }
216 4 $self->end_element({'Name' => 'Hsp'});
217 4 $self->{'_currentHSP'} = {};
218 }
219 1 ▶ $format = 0 if @hsps;
Branch: 1 branch
BranchTrueFalseTotal
if @hsps 1 0 1
220 1 @hsps = ();
221 1 %alignment = ();
222 1 $qfull = 0;
223 1 $hit_direction = 1;
224 1 $self->end_element({'Name' => 'Hit'});
225 }
226  
227 # This line describes the current hit... so let's start it
228 } elsif( /^seq2\s*=\s*(\S+)\s+\(>?(\S+)\s*\),\s*(\d+)/ ) {
229 7 $self->start_element({'Name' => 'Hit'});
230 7 $self->element( {'Name' => 'Hit_id', 'Data' => $2} );
231 7 $self->element( {'Name' => 'Hit_desc', 'Data' => $1} );
232 7 $self->element( {'Name' => 'Hit_len', 'Data' => $3} );
233  
234 # This line may give additional details about query or subject
235 } elsif( /^>(\S+)\s*(.*)?/ ) {
236 # Previous line was query details... this time subject details
237 2 ▶ if( $qfull ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($qfull) { } 1 1 2
238 1 ▶ $format = 4 if !$format;
Branch: 1 branch
BranchTrueFalseTotal
unless $format 1 0 1
239 1 $self->element({'Name' => 'Hit_desc', 'Data' => $2});
240 # First line of this type is always query details for a given hit
241 } else {
242 1 $self->element({'Name' => 'Sim4Output_query-desc', 'Data' => $2});
243 1 $qfull = 1;
244 }
245  
246 # This line indicates that subject is on reverse strand
247 } elsif( /^\(complement\)/ ) {
248 2 $hit_direction = -1;
249  
250 # This line describes the current HSP... so add it to @hsps array
251 } elsif( /^\(?(\d+)\-(\d+)\)?\s+\(?(\d+)\-(\d+)\)?\s+(\d+)/ ) {
252 28 my ($qs,$qe,$hs,$he,$pid) = ($1,$2,$3,$4,$5);
253 28 ▶ push @hsps, {
Branch: 2 branches
BranchTrueFalseTotal
$hit_direction >= 0 ? : 14 14 28
$hit_direction >= 0 ? : 14 14 28
254 'Hsp_query-from' => $qs,
255 'Hsp_query-to' => $qe,
256 'Hsp_hit-from' => $hit_direction >= 0 ? $hs : $he,
257 'Hsp_hit-to' => $hit_direction >= 0 ? $he : $hs,
258 'Hsp_identity' => 0, #can't determine correctly from raw pct
259 'Hsp_qlength' => abs($qe - $qs) + 1,
260 'Hsp_hlength' => abs($he - $hs) + 1,
261 'Hsp_align-len' => abs($qe - $qs) + 1,
262 };
263  
264 # This line indicates the start of an alignment block
265 } elsif( /^\s+(\d+)\s/ ) {
266 # Store the current alignment block in a hash
267 8 ▶ for( my $i = 0; defined($_) && $i < 4; $i++ ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $_ and $i < 4) 32 8 40
Condition66%2/3
defined $_ and $i < 4
!ll&&!rl&&r
0832
MC/DC50%1/2
defined $_ and $i < 4
defined $_ $i < 4
Truth table66%2/3
A and B
A= defined $_B= $i < 4
ABresult
0X0
100
111
268 32 my ($start, $string) = /^\s+(\d*)\s(.*)/;
269 $alignment{$ALIGN_TYPES{$i}} = { start => $start, string => $i != 2
270 ? $string
271 32 ▶ : (' ' x (length($alignment{$ALIGN_TYPES{$i-1}}{string}) - length($string))) . $string
Branch: 1 branch
BranchTrueFalseTotal
$i != 2 ? : 24 8 32
272 };
273 32 $_ = $self->_readline();
274 }
275  
276 # 'Ruler' line indicates the start of a new HSP
277 8 ▶ if ($alignment{Ruler}{start} == 0) {
Branch: 1 branch
BranchTrueFalseTotal
if ($alignment{"Ruler"}{"start"} == 0) 2 6 8
278 2 ▶ $format = @hsps ? 3 : 1 if !$format;
Branch: 2 branches
BranchTrueFalseTotal
unless $format 1 1 2
@hsps ? : 1 0 1
279 # A previous HSP may need to be ended
280 2 ▶ $self->end_element({'Name' => 'Hsp'}) if ( $self->in_element('hsp') );
Branch: 1 branch
BranchTrueFalseTotal
if $self->in_element("hsp") 0 2 2
281 # Start the new HSP and fill the '_currentHSP' property with available details
282 2 $self->start_element({'Name' => 'Hsp'});
283 $self->{'_currentHSP'} = @hsps ? shift @hsps : {
284 'Hsp_query-from' => $alignment{Query}{start},
285 'Hsp_hit-from' => $alignment{Sbjct}{start},
286 }
287 2 ▶ }
Branch: 1 branch
BranchTrueFalseTotal
@hsps ? : 2 0 2
288  
289 # Midline indicates a boundary between two HSPs
290 8 ▶ if ( $alignment{Mid}{string} =~ /<|>/g ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($alignment{'Mid'}{'string'} =~ /<|>/g) { } 4 4 8
291 4 my ($hsp_start, $hsp_end);
292 # Are we currently in an open HSP?
293 4 ▶ if ( $self->in_element('hsp') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->in_element('hsp')) { } 2 2 4
294 # Find end pos, adjust 'gaps', 'seq' and 'midline' properties... then close HSP
295 2 $hsp_end = (pos $alignment{Mid}{string}) - 1;
296 $self->{'_currentHSP'}{'Hsp_querygaps'} +=
297 2 ($self->{'_currentHSP'}{'Hsp_qseq'} .= substr($alignment{Query}{string}, 0, $hsp_end)) =~ s/ /-/g;
298 $self->{'_currentHSP'}{'Hsp_hitgaps'} +=
299 2 ($self->{'_currentHSP'}{'Hsp_hseq'} .= substr($alignment{Sbjct}{string}, 0, $hsp_end)) =~ s/ /-/g;
300 2 ($self->{'_currentHSP'}{'Hsp_midline'} .= substr($alignment{Mid}{string}, 0, $hsp_end)) =~ s/-/ /g;
301 2 $self->end_element({'Name' => 'Hsp'});
302  
303 # Does a new HSP start in the current alignment block?
304 2 ▶ if ( $alignment{Mid}{string} =~ /\|/g ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($alignment{"Mid"}{"string"} =~ /\|/g) 0 2 2
305 # Find start pos, start new HSP and fill it with available details
306 0 $hsp_start = (pos $alignment{Mid}{string}) - 1;
307 0 $self->start_element({'Name' => 'Hsp'});
308 0 ▶ $self->{'_currentHSP'} = @hsps ? shift @hsps : {};
Branch: 1 branch
BranchTrueFalseTotal
@hsps ? : 0 0 0
309 $self->{'_currentHSP'}{'Hsp_querygaps'} +=
310 0 ($self->{'_currentHSP'}{'Hsp_qseq'} = substr($alignment{Query}{string}, $hsp_start)) =~ s/ /-/g;
311 $self->{'_currentHSP'}{'Hsp_hitgaps'} +=
312 0 ($self->{'_currentHSP'}{'Hsp_hseq'} = substr($alignment{Sbjct}{string}, $hsp_start)) =~ s/ /-/g;
313 0 ($self->{'_currentHSP'}{'Hsp_midline'} = substr($alignment{Mid}{string}, $hsp_start)) =~ s/-/ /g;
314 }
315 }
316 # No HSP is currently open...
317 else {
318 # Find start pos, start new HSP and fill it with available
319 # details then skip to next alignment block
320 2 $hsp_start = index($alignment{Mid}{string}, '|');
321 2 $self->start_element({'Name' => 'Hsp'});
322 $self->{'_currentHSP'} = @hsps ? shift @hsps : {
323 'Hsp_query-from' => $alignment{Query}{start},
324 2 ▶ };
Branch: 1 branch
BranchTrueFalseTotal
@hsps ? : 2 0 2
325 $self->{'_currentHSP'}{'Hsp_querygaps'} +=
326 2 ($self->{'_currentHSP'}{'Hsp_qseq'} = substr($alignment{Query}{string}, $hsp_start)) =~ s/ /-/g;
327 $self->{'_currentHSP'}{'Hsp_hitgaps'} +=
328 2 ($self->{'_currentHSP'}{'Hsp_hseq'} = substr($alignment{Sbjct}{string}, $hsp_start)) =~ s/ /-/g;
329 2 ($self->{'_currentHSP'}{'Hsp_midline'} = substr($alignment{Mid}{string}, $hsp_start)) =~ s/-/ /g;
330 2 next;
331 }
332 }
333 # Current alignment block does not contain HSPs boundary
334 else {
335 # Start a new HSP if none is currently open
336 # (Happens if last boundary finished at the very end of previous block)
337 4 ▶ if ( !$self->in_element('hsp') ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->in_element("hsp")) 0 4 4
338 0 $self->start_element({'Name' => 'Hsp'});
339 $self->{'_currentHSP'} = @hsps ? shift @hsps : {
340 'Hsp_query-from' => $alignment{Query}{start},
341 'Hsp_hit-from' => $alignment{Sbjct}{start},
342 }
343 0 ▶ }
Branch: 1 branch
BranchTrueFalseTotal
@hsps ? : 0 0 0
344 # Adjust details of the current HSP
345 $self->{'_currentHSP'}{'Hsp_query-from'} ||=
346 $alignment{Query}{start} -
347 4 ▶ length($self->{'_currentHSP'}{'Hsp_qseq'} || '');
Condition20%1/5
$self->{"_currentHSP"}{"Hsp_query-from"} ||= $alignment{"Query"}{"start"} - length($self->{"_currentHSP"}{"Hsp_qseq"} or "")
l!l&&r!l&&!r
400
$self->{'_currentHSP'}{'Hsp_qseq'} || ''
l!l
00
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_query-from"} ||= $alignment{"Query"}{"start"} - length($self->{"_currentHSP"}{"Hsp_qseq"} or "")
$self->{"_currentHSP"}{"Hsp_query-from"} $alignment{"Query"}{"start"} - length($self->{"_currentHSP"}{"Hsp_qseq"} or "")
MC/DC0%0/1
$self->{'_currentHSP'}{'Hsp_qseq'} || ''
$self->{'_currentHSP'}{'Hsp_qseq'}
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_query-from"}B= $alignment{"Query"}{"start"} - length($self->{"_currentHSP"}{"Hsp_qseq"} or "")
ABresult
1X1
011
000
Truth table0%0/2
A
A= $self->{'_currentHSP'}{'Hsp_qseq'}
Aresult
11
00
348 $self->{'_currentHSP'}{'Hsp_hit-from'} ||=
349 $alignment{Sbjct}{start} -
350 4 ▶ length($self->{'_currentHSP'}{'Hsp_hseq'} || '');
Condition20%1/5
$self->{"_currentHSP"}{"Hsp_hit-from"} ||= $alignment{"Sbjct"}{"start"} - length($self->{"_currentHSP"}{"Hsp_hseq"} or "")
l!l&&r!l&&!r
400
$self->{'_currentHSP'}{'Hsp_hseq'} || ''
l!l
00
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_hit-from"} ||= $alignment{"Sbjct"}{"start"} - length($self->{"_currentHSP"}{"Hsp_hseq"} or "")
$self->{"_currentHSP"}{"Hsp_hit-from"} $alignment{"Sbjct"}{"start"} - length($self->{"_currentHSP"}{"Hsp_hseq"} or "")
MC/DC0%0/1
$self->{'_currentHSP'}{'Hsp_hseq'} || ''
$self->{'_currentHSP'}{'Hsp_hseq'}
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_hit-from"}B= $alignment{"Sbjct"}{"start"} - length($self->{"_currentHSP"}{"Hsp_hseq"} or "")
ABresult
1X1
011
000
Truth table0%0/2
A
A= $self->{'_currentHSP'}{'Hsp_hseq'}
Aresult
11
00
351 $self->{'_currentHSP'}{'Hsp_querygaps'} +=
352 ($self->{'_currentHSP'}{'Hsp_qseq'} .=
353 4 $alignment{Query}{string}) =~ s/ /-/g;
354 $self->{'_currentHSP'}{'Hsp_hitgaps'} +=
355 ($self->{'_currentHSP'}{'Hsp_hseq'} .=
356 4 $alignment{Sbjct}{string}) =~ s/ /-/g;
357 ($self->{'_currentHSP'}{'Hsp_midline'} .=
358 4 $alignment{Mid}{string}) =~ s/-/ /g;
359 }
360 }
361 }
362  
363 # We are done reading the sim4 report, end everything and return
364 6 ▶ if( $seentop ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($seentop) 6 0 6
365 # end HSP if needed
366 6 ▶ $self->end_element({'Name' => 'Hsp'}) if ( $self->in_element('hsp') );
Branch: 1 branch
BranchTrueFalseTotal
if $self->in_element("hsp") 2 4 6
367 # end Hit if needed
368 6 ▶ if ( $self->in_element('hit') ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->in_element("hit")) 6 0 6
369 6 foreach (@hsps) {
370 20 $self->start_element({'Name' => 'Hsp'});
371 20 ▶ while (my ($name, $data) = each %$_) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %$_) 160 20 180
372 160 $self->{'_currentHSP'}{$name} = $data;
373 }
374 20 $self->end_element({'Name' => 'Hsp'});
375 }
376 6 $self->end_element({'Name' => 'Hit'});
377 }
378 # adjust result's algorithm name, end output and return
379 6 ▶ $self->element({'Name' => 'Sim4Output_program',
Branch: 1 branch
BranchTrueFalseTotal
defined $format ? : 3 3 6
380 'Data' => $DEFAULTFORMAT . ' (A=' . (defined $format ? $format : '?') . ')'});
381 6 $self->end_element({'Name' => 'Sim4Output'});
382 6 return $self->end_document();
383 }
384 0 return;
385 }
386  
387 =head2 start_element
388  
389 Title : start_element
390 Usage : $eventgenerator->start_element
391 Function: Handles a start element event
392 Returns : none
393 Args : hashref with at least 2 keys 'Data' and 'Name'
394  
395  
396 =cut
397  
398 378 ▶sub start_element{
Subroutine start_element: called CC=4 SCAR=13.9
Pod documented
399 378 my ($self,$data) = @_;
400 # we currently don't care about attributes
401 378 my $nm = $data->{'Name'};
402 378 my $type = $MODEMAP{$nm};
403  
404 378 ▶ if( $type ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($type) 41 337 378
405 41 ▶ if( $self->_will_handle($type) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_will_handle($type)) 41 0 41
406 41 my $func = sprintf("start_%s",lc $type);
407 41 $self->_eventHandler->$func($data->{'Attributes'});
408 }
409 41 unshift @{$self->{'_elements'}}, $type;
410  
411 41 ▶ if($type eq 'result') {
Branch: 1 branch
BranchTrueFalseTotal
if ($type eq "result") 6 35 41
412 6 $self->{'_values'} = {};
413 6 $self->{'_result'}= undef;
414 }
415 }
416  
417 }
418  
419 =head2 end_element
420  
421 Title : start_element
422 Usage : $eventgenerator->end_element
423 Function: Handles an end element event
424 Returns : none
425 Args : hashref with at least 2 keys 'Data' and 'Name'
426  
427  
428 =cut
429  
430 378 ▶sub end_element {
Subroutine end_element: called CC=17 SCAR=31.3
Pod documented
431 378 my ($self,$data) = @_;
432 378 my $nm = $data->{'Name'};
433 378 my $type = $MODEMAP{$nm};
434 378 my $rc;
435
436 378 ▶ if( $nm eq 'Hsp' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($nm eq "Hsp") 28 350 378
437 28 ▶ $self->{'_currentHSP'}{'Hsp_midline'} ||= '';
Condition100%2/2
$self->{"_currentHSP"}{"Hsp_midline"} ||= ""
l!l
424
MC/DC100%1/1
$self->{"_currentHSP"}{"Hsp_midline"} ||= ""
$self->{"_currentHSP"}{"Hsp_midline"}
Truth table100%2/2
A
A= $self->{"_currentHSP"}{"Hsp_midline"}
Aresult
11
00
438 $self->{'_currentHSP'}{'Hsp_query-to'} ||=
439 28 ▶ $self->{'_currentHSP'}{'Hsp_query-from'} + length($self->{'_currentHSP'}{'Hsp_qseq'}) - 1 - $self->{'_currentHSP'}{'Hsp_querygaps'};
Condition33%1/3
$self->{"_currentHSP"}{"Hsp_query-to"} ||= $self->{"_currentHSP"}{"Hsp_query-from"} + length($self->{"_currentHSP"}{"Hsp_qseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_querygaps"}
l!l&&r!l&&!r
2800
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_query-to"} ||= $self->{"_currentHSP"}{"Hsp_query-from"} + length($self->{"_currentHSP"}{"Hsp_qseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_querygaps"}
$self->{"_currentHSP"}{"Hsp_query-to"} $self->{"_currentHSP"}{"Hsp_query-from"} + length($self->{"_currentHSP"}{"Hsp_qseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_querygaps"}
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_query-to"}B= $self->{"_currentHSP"}{"Hsp_query-from"} + length($self->{"_currentHSP"}{"Hsp_qseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_querygaps"}
ABresult
1X1
011
000
440 $self->{'_currentHSP'}{'Hsp_hit-to'} ||=
441 28 ▶ $self->{'_currentHSP'}{'Hsp_hit-from'} + length($self->{'_currentHSP'}{'Hsp_hseq'}) - 1 - $self->{'_currentHSP'}{'Hsp_hitgaps'};
Condition33%1/3
$self->{"_currentHSP"}{"Hsp_hit-to"} ||= $self->{"_currentHSP"}{"Hsp_hit-from"} + length($self->{"_currentHSP"}{"Hsp_hseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_hitgaps"}
l!l&&r!l&&!r
2800
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_hit-to"} ||= $self->{"_currentHSP"}{"Hsp_hit-from"} + length($self->{"_currentHSP"}{"Hsp_hseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_hitgaps"}
$self->{"_currentHSP"}{"Hsp_hit-to"} $self->{"_currentHSP"}{"Hsp_hit-from"} + length($self->{"_currentHSP"}{"Hsp_hseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_hitgaps"}
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_hit-to"}B= $self->{"_currentHSP"}{"Hsp_hit-from"} + length($self->{"_currentHSP"}{"Hsp_hseq"}) - 1 - $self->{"_currentHSP"}{"Hsp_hitgaps"}
ABresult
1X1
011
000
442 $self->{'_currentHSP'}{'Hsp_identity'} ||=
443 28 ▶ ($self->{'_currentHSP'}{'Hsp_midline'} =~ tr/\|//);
Condition66%2/3
$self->{"_currentHSP"}{"Hsp_identity"} ||= $self->{"_currentHSP"}{"Hsp_midline"} =~ tr/|//
l!l&&r!l&&!r
0424
MC/DC50%1/2
$self->{"_currentHSP"}{"Hsp_identity"} ||= $self->{"_currentHSP"}{"Hsp_midline"} =~ tr/|//
$self->{"_currentHSP"}{"Hsp_identity"} $self->{"_currentHSP"}{"Hsp_midline"} =~ tr/|//
Truth table66%2/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_identity"}B= $self->{"_currentHSP"}{"Hsp_midline"} =~ tr/|//
ABresult
1X1
011
000
444 28 ▶ $self->{'_currentHSP'}{'Hsp_qlength'} ||= abs($self->{'_currentHSP'}{'Hsp_query-to'} - $self->{'_currentHSP'}{'Hsp_query-from'}) + 1;
Condition33%1/3
$self->{"_currentHSP"}{"Hsp_qlength"} ||= abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
l!l&&r!l&&!r
2800
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_qlength"} ||= abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
$self->{"_currentHSP"}{"Hsp_qlength"} abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_qlength"}B= abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
ABresult
1X1
011
000
445 28 ▶ $self->{'_currentHSP'}{'Hsp_hlength'} ||= abs($self->{'_currentHSP'}{'Hsp_hit-to'} - $self->{'_currentHSP'}{'Hsp_hit-from'}) + 1;
Condition33%1/3
$self->{"_currentHSP"}{"Hsp_hlength"} ||= abs($self->{"_currentHSP"}{"Hsp_hit-to"} - $self->{"_currentHSP"}{"Hsp_hit-from"}) + 1
l!l&&r!l&&!r
2800
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_hlength"} ||= abs($self->{"_currentHSP"}{"Hsp_hit-to"} - $self->{"_currentHSP"}{"Hsp_hit-from"}) + 1
$self->{"_currentHSP"}{"Hsp_hlength"} abs($self->{"_currentHSP"}{"Hsp_hit-to"} - $self->{"_currentHSP"}{"Hsp_hit-from"}) + 1
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_hlength"}B= abs($self->{"_currentHSP"}{"Hsp_hit-to"} - $self->{"_currentHSP"}{"Hsp_hit-from"}) + 1
ABresult
1X1
011
000
446 28 ▶ $self->{'_currentHSP'}{'Hsp_align-len'} ||= abs($self->{'_currentHSP'}{'Hsp_query-to'} - $self->{'_currentHSP'}{'Hsp_query-from'}) + 1;
Condition33%1/3
$self->{"_currentHSP"}{"Hsp_align-len"} ||= abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
l!l&&r!l&&!r
2800
MC/DC0%0/2
$self->{"_currentHSP"}{"Hsp_align-len"} ||= abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
$self->{"_currentHSP"}{"Hsp_align-len"} abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
Truth table33%1/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_align-len"}B= abs($self->{"_currentHSP"}{"Hsp_query-to"} - $self->{"_currentHSP"}{"Hsp_query-from"}) + 1
ABresult
1X1
011
000
447 28 ▶ $self->{'_currentHSP'}{'Hsp_score'} ||= int(100 * ($self->{'_currentHSP'}{'Hsp_identity'} / $self->{'_currentHSP'}{'Hsp_align-len'}));
Condition66%2/3
$self->{"_currentHSP"}{"Hsp_score"} ||= int 100 * ($self->{"_currentHSP"}{"Hsp_identity"} / $self->{"_currentHSP"}{"Hsp_align-len"})
l!l&&r!l&&!r
0424
MC/DC50%1/2
$self->{"_currentHSP"}{"Hsp_score"} ||= int 100 * ($self->{"_currentHSP"}{"Hsp_identity"} / $self->{"_currentHSP"}{"Hsp_align-len"})
$self->{"_currentHSP"}{"Hsp_score"} int 100 * ($self->{"_currentHSP"}{"Hsp_identity"} / $self->{"_currentHSP"}{"Hsp_align-len"})
Truth table66%2/3
A ||= B
A= $self->{"_currentHSP"}{"Hsp_score"}B= int 100 * ($self->{"_currentHSP"}{"Hsp_identity"} / $self->{"_currentHSP"}{"Hsp_align-len"})
ABresult
1X1
011
000
448 28 foreach (keys %{$self->{'_currentHSP'}}) {
449 296 $self->element({'Name' => $_, 'Data' => delete ${$self->{'_currentHSP'}}{$_}});
450 }
451 }
452  
453 378 ▶ if( $type = $MODEMAP{$nm} ) {
Branch: 2 branches
BranchTrueFalseTotal
if ($type = $Bio::SearchIO::sim4::MODEMAP{$nm}) { } 41 337 378
elsif ($Bio::SearchIO::sim4::MAPPING{$nm}) { } 337 0 337
454 41 ▶ if( $self->_will_handle($type) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_will_handle($type)) 41 0 41
455 41 my $func = sprintf("end_%s",lc $type);
456 $rc = $self->_eventHandler->$func($self->{'_reporttype'},
457 41 $self->{'_values'});
458 }
459 41 shift @{$self->{'_elements'}};
460  
461 } elsif( $MAPPING{$nm} ) {
462  
463 337 ▶ if ( ref($MAPPING{$nm}) =~ /hash/i ) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref($Bio::SearchIO::sim4::MAPPING{$nm}) =~ /hash/i) { } 0 337 337
464 0 my $key = (keys %{$MAPPING{$nm}})[0];
465 0 $self->{'_values'}->{$key}->{$MAPPING{$nm}->{$key}} = $self->{'_last_data'};
466 } else {
467 337 $self->{'_values'}->{$MAPPING{$nm}} = $self->{'_last_data'};
468 }
469 } else {
470 0 $self->debug( "unknown nm $nm, ignoring\n");
471 }
472 378 $self->{'_last_data'} = ''; # remove read data if we are at
473 # end of an element
474 378 ▶ $self->{'_result'} = $rc if( defined $type && $type eq 'result' );
Branch: 1 branch
BranchTrueFalseTotal
if defined $type and $type eq "result" 6 372 378
Condition100%3/3
defined $type and $type eq "result"
!ll&&!rl&&r
337356
MC/DC100%2/2
defined $type and $type eq "result"
defined $type $type eq "result"
Truth table100%3/3
A and B
A= defined $typeB= $type eq "result"
ABresult
0X0
100
111
475 378 return $rc;
476 }
477  
478 =head2 element
479  
480 Title : element
481 Usage : $eventhandler->element({'Name' => $name, 'Data' => $str});
482 Function: Convience method that calls start_element, characters, end_element
483 Returns : none
484 Args : Hash ref with the keys 'Name' and 'Data'
485  
486  
487 =cut
488  
489 337 ▶sub element{
Subroutine element: called CC=1 SCAR=0.0
Pod documented
490 337 my ($self,$data) = @_;
491 337 $self->start_element($data);
492 337 $self->characters($data);
493 337 $self->end_element($data);
494 }
495  
496 =head2 characters
497  
498 Title : characters
499 Usage : $eventgenerator->characters($str)
500 Function: Send a character events
501 Returns : none
502 Args : string
503  
504  
505 =cut
506  
507 337 ▶sub characters{
Subroutine characters: called CC=5 SCAR=16.5
Pod documented
508 337 my ($self,$data) = @_;
509 337 ▶ return unless ( defined $data->{'Data'} && $data->{'Data'} !~ /^\s+$/ );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $data->{"Data"} and not $data->{"Data"} =~ /^\s+$/ 0 337 337
Condition33%1/3
defined $data->{"Data"} and not $data->{"Data"} =~ /^\s+$/
!ll&&!rl&&r
00337
MC/DC0%0/2
defined $data->{"Data"} and not $data->{"Data"} =~ /^\s+$/
defined $data->{"Data"} not $data->{"Data"} =~ /^\s+$/
Truth table33%1/3
A and not(B)
A= defined $data->{"Data"}B= not $data->{"Data"} =~ /^\s+$/
ABresult
0X0
100
111
510
511 337 ▶ if( $self->in_element('hsp') &&
Branch: 1 branch
BranchTrueFalseTotal
if ($self->in_element("hsp") and $data->{"Name"} =~ /Hsp\_(qseq|hseq|midline)/) 36 301 337
Condition100%3/3
$self->in_element("hsp") and $data->{"Name"} =~ /Hsp\_(qseq|hseq|midline)/
!ll&&!rl&&r
4126036
MC/DC100%2/2
$self->in_element("hsp") and $data->{"Name"} =~ /Hsp\_(qseq|hseq|midline)/
$self->in_element("hsp") $data->{"Name"} =~ /Hsp\_(qseq|hseq|midline)/
Truth table100%3/3
A and B
A= $self->in_element("hsp")B= $data->{"Name"} =~ /Hsp\_(qseq|hseq|midline)/
ABresult
0X0
100
111
512 $data->{'Name'} =~ /Hsp\_(qseq|hseq|midline)/ ) {
513 36 $self->{'_last_hspdata'}->{$data->{'Name'}} .= $data->{'Data'};
514 }
515  
516 337 $self->{'_last_data'} = $data->{'Data'};
517 }
518  
519 =head2 within_element
520  
521 Title : within_element
522 Usage : if( $eventgenerator->within_element($element) ) {}
523 Function: Test if we are within a particular element
524 This is different than 'in' because within can be tested
525 for a whole block.
526 Returns : boolean
527 Args : string element name
528  
529  
530 =cut
531  
532 0 ▶sub within_element{
Subroutine within_element: not called CC=6 SCAR=37.4
Pod documented
533 0 my ($self,$name) = @_;
534 return 0 if ( ! defined $name &&
535 ! defined $self->{'_elements'} ||
536 0 ▶ scalar @{$self->{'_elements'}} == 0) ;
Branch: 1 branch
BranchTrueFalseTotal
if not defined $name || defined $self->{"_elements"} or scalar @{$self->{"_elements"};} == 0 0 0 0
Condition0%0/6
not defined $name || defined $self->{"_elements"} or scalar @{$self->{"_elements"};} == 0
l!l&&r!l&&!r
000
defined $name || defined $self->{'_elements'}
l!l&&r!l&&!r
000
MC/DC0%0/3
not defined $name || defined $self->{"_elements"} or scalar @{$self->{"_elements"};} == 0
defined $name defined $self->{'_elements'} scalar @{$self->{"_elements"};} == 0
Truth table0%0/5
not(A || B) or C
A= defined $nameB= defined $self->{'_elements'}C= scalar @{$self->{"_elements"};} == 0
ABCresult
00X1
1X11
0111
1X00
0100
537 0 foreach ( @{$self->{'_elements'}} ) {
538 0 ▶ if( $_ eq $name ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($_ eq $name) 0 0 0
539 0 return 1;
540 }
541 }
542 0 return 0;
543 }
544  
545  
546 =head2 in_element
547  
548 Title : in_element
549 Usage : if( $eventgenerator->in_element($element) ) {}
550 Function: Test if we are in a particular element
551 This is different than 'in' because within can be tested
552 for a whole block.
553 Returns : boolean
554 Args : string element name
555  
556  
557 =cut
558  
559 373 ▶sub in_element{
Subroutine in_element: called CC=2 SCAR=7.1
Pod documented
560 373 my ($self,$name) = @_;
561 373 ▶ return 0 if ! defined $self->{'_elements'}->[0];
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"_elements"}[0] 0 373 373
562 373 return ( $self->{'_elements'}->[0] eq $name)
563 }
564  
565 =head2 start_document
566  
567 Title : start_document
568 Usage : $eventgenerator->start_document
569 Function: Handle a start document event
570 Returns : none
571 Args : none
572  
573  
574 =cut
575  
576 6 ▶sub start_document{
Subroutine start_document: called CC=1 SCAR=0.0
Pod documented
577 6 my ($self) = @_;
578 6 $self->{'_lasttype'} = '';
579 6 $self->{'_values'} = {};
580 6 $self->{'_result'}= undef;
581 6 $self->{'_elements'} = [];
582 6 $self->{'_reporttype'} = $DEFAULTFORMAT;
583 }
584  
585  
586 =head2 end_document
587  
588 Title : end_document
589 Usage : $eventgenerator->end_document
590 Function: Handles an end document event
591 Returns : Bio::Search::Result::ResultI object
592 Args : none
593  
594  
595 =cut
596  
597 6 ▶sub end_document{
Subroutine end_document: called CC=1 SCAR=0.0
Pod documented
598 6 my ($self,@args) = @_;
599 6 return $self->{'_result'};
600 }
601  
602  
603 0 ▶sub write_result {
Subroutine write_result: not called CC=2 SCAR=17.9
Pod documented
604 0 my ($self, $blast, @args) = @_;
605  
606 0 ▶ if( not defined($self->writer) ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $self->writer) 0 0 0
607 0 $self->warn("Writer not defined. Using a $DEFAULT_WRITER_CLASS");
608 0 $self->writer( $DEFAULT_WRITER_CLASS->new() );
609 }
610 0 $self->SUPER::write_result( $blast, @args );
611 }
612  
613 0 ▶sub result_count {
Subroutine result_count: not called CC=1 SCAR=6.9
Pod documented
614 0 return 1; # can a sim4 report contain more than one result?
615 }
616  
617 0 ▶sub report_count { shift->result_count }
Subroutine report_count: not called CC=1 SCAR=6.9
Pod undocumented
618  
619 =head2 _will_handle
620  
621 Title : _will_handle
622 Usage : Private method. For internal use only.
623 if( $self->_will_handle($type) ) { ... }
624 Function: Provides an optimized way to check whether or not an element of a
625 given type is to be handled.
626 Returns : Reference to EventHandler object if the element type is to be handled.
627 undef if the element type is not to be handled.
628 Args : string containing type of element.
629  
630 Optimizations:
631  
632 1. Using the cached pointer to the EventHandler to minimize repeated lookups.
633 2. Caching the will_handle status for each type that is encountered
634 so that it only need be checked by calling handler->will_handle($type) once.
635  
636 This does not lead to a major savings by itself (only 5-10%).
637 In combination with other optimizations, or for large parse jobs, the
638 savings good be significant.
639  
640 To test against the unoptimized version, remove the parentheses from
641 around the third term in the ternary " ? : " operator and add two
642 calls to $self-E<gt>_eventHandler().
643  
644 =cut
645  
646 82 ▶sub _will_handle {
Subroutine _will_handle: called CC=4 SCAR=14.1
647 82 my ($self,$type) = @_;
648 82 ▶ my $handler = $self->{'_handler_cache'} ||= $self->_eventHandler;
Condition66%2/3
$self->{"_handler_cache"} ||= $self->_eventHandler
l!l&&r!l&&!r
7660
MC/DC0%0/2
$self->{"_handler_cache"} ||= $self->_eventHandler
$self->{"_handler_cache"} $self->_eventHandler
Truth table66%2/3
A ||= B
A= $self->{"_handler_cache"}B= $self->_eventHandler
ABresult
1X1
011
000
649  
650 my $will_handle = defined($self->{'_will_handle_cache'}->{$type})
651 ? $self->{'_will_handle_cache'}->{$type}
652 82 ▶ : ($self->{'_will_handle_cache'}->{$type} =
Branch: 1 branch
BranchTrueFalseTotal
defined $self->{'_will_handle_cache'}{$type} ? : 64 18 82
653 $handler->will_handle($type));
654  
655 82 ▶ return $will_handle ? $handler : undef;
Branch: 1 branch
BranchTrueFalseTotal
$will_handle ? : 82 0 82
656 }
657  
658 2 1;
« Bio/SearchIO/rnamotif.pm ↑ Summary Bio/PrimarySeqI.pm »