Bio/Search/Hit/BlastPullHit.pm

filter: Statementstmt 95.7% 90 / 94 Branchbran 92.3% 24 / 26 Conditioncond 72.4% 21 / 29 MC/DCmcdc 44.4% 8 / 18 Subroutinesub 85.7% 12 / 14 Podpod 100% 6 / 6 totaltotal 86.1% 161 / 187 CC 27 SCAR 17.7
CC
27
Cov
91%
_discover_start_end
10.0
_discover_next_hsp
8.3
hsp
6.0
CRAP 5.8
« Bio/Seq.pm ↑ Summary Bio/Tree/Tree.pm »
1 #
2 # BioPerl module for Bio::Search::Hit::BlastPullHit
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Sendu Bala <bix@sendu.me.uk>
7 #
8 # Copyright Sendu Bala
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::Search::Hit::BlastPullHit - A parser and hit object for BLASTN hits
17  
18 =head1 SYNOPSIS
19  
20 # generally we use Bio::SearchIO to build these objects
21 use Bio::SearchIO;
22 my $in = Bio::SearchIO->new(-format => 'blast_pull',
23 -file => 'result.blast');
24  
25 while (my $result = $in->next_result) {
26 while (my $hit = $result->next_hit) {
27 print $hit->name, "\n";
28 print $hit->score, "\n";
29 print $hit->significance, "\n";
30  
31 while (my $hsp = $hit->next_hsp) {
32 # process HSPI objects
33 }
34 }
35 }
36  
37 =head1 DESCRIPTION
38  
39 This object implements a parser for BLASTN hit output.
40  
41 =head1 FEEDBACK
42  
43 =head2 Mailing Lists
44  
45 User feedback is an integral part of the evolution of this and other
46 Bioperl modules. Send your comments and suggestions preferably to
47 the Bioperl mailing list. Your participation is much appreciated.
48  
49 bioperl-l@bioperl.org - General discussion
50 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
51  
52 =head2 Support
53  
54 Please direct usage questions or support issues to the mailing list:
55  
56 I<bioperl-l@bioperl.org>
57  
58 rather than to the module maintainer directly. Many experienced and
59 reponsive experts will be able look at the problem and quickly
60 address it. Please include a thorough description of the problem
61 with code and data examples if at all possible.
62  
63 =head2 Reporting Bugs
64  
65 Report bugs to the Bioperl bug tracking system to help us keep track
66 of the bugs and their resolution. Bug reports can be submitted via the
67 web:
68  
69 https://github.com/bioperl/bioperl-live/issues
70  
71 =head1 AUTHOR - Sendu Bala
72  
73 Email bix@sendu.me.uk
74  
75 =head1 CONTRIBUTORS
76  
77 Additional contributors names and emails here
78  
79 =head1 APPENDIX
80  
81 The rest of the documentation details each of the object methods.
82 Internal methods are usually preceded with a _
83  
84 =cut
85  
86 # Let the code begin...
87  
88 package Bio::Search::Hit::BlastPullHit;
89 4 $Bio::Search::Hit::BlastPullHit::VERSION = '1.7.8';
90 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
91  
92 4 ▶use Bio::Search::HSP::BlastPullHSP;
Subroutine BEGIN: called CC=1 SCAR=0.0
93  
94 4 ▶use base qw(Bio::Root::Root Bio::Search::Hit::PullHitI);
Subroutine BEGIN: called CC=1 SCAR=0.0
95  
96 =head2 new
97  
98 Title : new
99 Usage : my $obj = Bio::Search::Hit::BlastNHit->new();
100 Function: Builds a new Bio::Search::Hit::BlastNHit object.
101 Returns : Bio::Search::Hit::BlastNHit
102 Args : -chunk => [Bio::Root::IO, $start, $end] (required if no -parent)
103 -parent => Bio::PullParserI object (required if no -chunk)
104 -hit_data => array ref with [name description score significance]
105  
106 where the array ref provided to -chunk contains an IO object
107 for a filehandle to something representing the raw data of the
108 hit, and $start and $end define the tell() position within the
109 filehandle that the hit data starts and ends (optional; defaults
110 to start and end of the entire thing described by the filehandle)
111  
112 =cut
113  
114 39 ▶sub new {
Subroutine new: called CC=5 SCAR=16.3
Pod documented
115 39 my ($class, @args) = @_;
116 39 my $self = $class->SUPER::new(@args);
117
118 39 $self->_setup(@args);
119
120 39 my $fields = $self->_fields;
121 39 foreach my $field (qw( header start_end )) {
122 78 $fields->{$field} = undef;
123 }
124
125 39 my $hit_data = $self->_raw_hit_data;
126 39 ▶ if ($hit_data && ref($hit_data) eq 'ARRAY') {
Branch: 1 branch
BranchTrueFalseTotal
if ($hit_data and ref $hit_data eq "ARRAY") 39 0 39
Condition33%1/3
$hit_data and ref $hit_data eq "ARRAY"
!ll&&!rl&&r
0039
MC/DC0%0/2
$hit_data and ref $hit_data eq "ARRAY"
$hit_data ref $hit_data eq "ARRAY"
Truth table33%1/3
A and B
A= $hit_dataB= ref $hit_data eq "ARRAY"
ABresult
0X0
100
111
127 39 foreach my $field (qw(name description score significance)) {
128 156 $fields->{$field} = shift(@{$hit_data});
129 }
130 }
131
132 39 $self->_dependencies( { ( name => 'header',
133 length => 'header',
134 description => 'header',
135 accession => 'header',
136 next_hsp => 'header',
137 query_start => 'start_end',
138 query_end => 'start_end',
139 hit_start => 'start_end',
140 hit_end => 'start_end' ) } );
141
142 39 return $self;
143 }
144  
145 #
146 # PullParserI discovery methods so we can answer all HitI questions
147 #
148  
149 20 ▶sub _discover_header {
Subroutine _discover_header: called CC=3 SCAR=11.0
150 20 my $self = shift;
151 20 $self->_chunk_seek(0);
152 20 my $header = $self->_get_chunk_by_end("\n Score = ");
153
154 20 ▶ unless ($header) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($header) 3 17 20
155 # no alignment or other data; all information was in the hit table of
156 # the result
157 3 $self->_calculate_accession_from_name;
158
159 3 $self->_fields->{header} = 1;
160 3 return;
161 }
162
163 17 $self->{_after_header} = $self->_chunk_tell;
164
165 17 ($self->_fields->{name}, $self->_fields->{description}, $self->_fields->{length}) = $header =~ /^(\S+)\s+(\S.+?)?\s+Length\s*=\s*(\d+)/sm;
166 17 ▶ if ($self->_fields->{description}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_fields->{'description'}) { } 15 2 17
167 15 $self->_fields->{description} =~ s/\n//g;
168 }
169 else {
170 2 $self->_fields->{description} = '';
171 }
172
173 17 $self->_calculate_accession_from_name;
174
175 17 $self->_fields->{header} = 1;
176 }
177  
178 20 ▶sub _calculate_accession_from_name {
Subroutine _calculate_accession_from_name: called CC=3 SCAR=11.0
179 20 my $self = shift;
180 20 my $name = $self->get_field('name');
181 20 ▶ if ($name =~ /.+?\|.+?\|.+?\|(\w+)/) {
Branch: 2 branches
BranchTrueFalseTotal
if ($name =~ /.+?\|.+?\|.+?\|(\w+)/) { } 9 11 20
elsif ($self->_fields->{'name'} =~ /.+?\|(\w+)?\./) { } 6 5 11
182 9 $self->_fields->{accession} = $1;
183 }
184 elsif ($self->_fields->{name} =~ /.+?\|(\w+)?\./) {
185 # old form?
186 6 $self->_fields->{accession} = $1;
187 }
188 else {
189 5 $self->_fields->{accession} = $name;
190 }
191 }
192  
193 4 ▶sub _discover_start_end {
Subroutine _discover_start_end: called CC=10 SCAR=23.0
194 4 my $self = shift;
195
196 4 my ($q_start, $q_end, $h_start, $h_end);
197 4 foreach my $hsp ($self->hsps) {
198 9 my ($this_q_start, $this_h_start) = $hsp->start;
199 9 my ($this_q_end, $this_h_end) = $hsp->end;
200
201 9 ▶ if (! defined $q_start || $this_q_start < $q_start) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $q_start or $this_q_start < $q_start) 6 3 9
Condition100%3/3
not defined $q_start or $this_q_start < $q_start
l!l&&r!l&&!r
423
MC/DC100%2/2
not defined $q_start or $this_q_start < $q_start
not defined $q_start $this_q_start < $q_start
Truth table100%3/3
not(A) or B
A= not defined $q_startB= $this_q_start < $q_start
ABresult
1X1
011
000
202 6 $q_start = $this_q_start;
203 }
204 9 ▶ if (! defined $h_start || $this_h_start < $h_start) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $h_start or $this_h_start < $h_start) 6 3 9
Condition100%3/3
not defined $h_start or $this_h_start < $h_start
l!l&&r!l&&!r
423
MC/DC100%2/2
not defined $h_start or $this_h_start < $h_start
not defined $h_start $this_h_start < $h_start
Truth table100%3/3
not(A) or B
A= not defined $h_startB= $this_h_start < $h_start
ABresult
1X1
011
000
205 6 $h_start = $this_h_start;
206 }
207
208 9 ▶ if (! defined $q_end || $this_q_end > $q_end) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $q_end or $this_q_end > $q_end) 7 2 9
Condition100%3/3
not defined $q_end or $this_q_end > $q_end
l!l&&r!l&&!r
432
MC/DC100%2/2
not defined $q_end or $this_q_end > $q_end
not defined $q_end $this_q_end > $q_end
Truth table100%3/3
not(A) or B
A= not defined $q_endB= $this_q_end > $q_end
ABresult
1X1
011
000
209 7 $q_end = $this_q_end;
210 }
211 9 ▶ if (! defined $h_end || $this_h_end > $h_end) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $h_end or $this_h_end > $h_end) 5 4 9
Condition100%3/3
not defined $h_end or $this_h_end > $h_end
l!l&&r!l&&!r
414
MC/DC100%2/2
not defined $h_end or $this_h_end > $h_end
not defined $h_end $this_h_end > $h_end
Truth table100%3/3
not(A) or B
A= not defined $h_endB= $this_h_end > $h_end
ABresult
1X1
011
000
212 5 $h_end = $this_h_end;
213 }
214 }
215
216 4 $self->_fields->{query_start} = $q_start;
217 4 $self->_fields->{query_end} = $q_end;
218 4 $self->_fields->{hit_start} = $h_start;
219 4 $self->_fields->{hit_end} = $h_end;
220 }
221  
222 177 ▶sub _discover_next_hsp {
Subroutine _discover_next_hsp: called CC=8 SCAR=21.1
223 177 my $self = shift;
224 177 ▶ my $pos = $self->{_end_of_previous_hsp} || $self->{_after_header};
Condition66%2/3
$self->{'_end_of_previous_hsp'} || $self->{'_after_header'}
l!l&&r!l&&!r
144330
MC/DC0%0/2
$self->{'_end_of_previous_hsp'} || $self->{'_after_header'}
$self->{'_end_of_previous_hsp'} $self->{'_after_header'}
Truth table66%2/3
A || B
A= $self->{'_end_of_previous_hsp'}B= $self->{'_after_header'}
ABresult
1X1
011
000
225 177 ▶ return unless $pos;
Branch: 1 branch
BranchTrueFalseTotal
unless $pos 0 177 177
226 177 $self->_chunk_seek($pos);
227
228 177 my ($start, $end) = $self->_find_chunk_by_end("\n Score = ");
229 177 ▶ if ((defined $end && ($end + $self->_chunk_true_start) > $self->_chunk_true_end) || ! $end) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $end and $end + $self->_chunk_true_start > $self->_chunk_true_end or not $end) { } 45 132 177
Condition66%4/6
defined $end and $end + $self->_chunk_true_start > $self->_chunk_true_end or not $end
l!l&&r!l&&!r
045132
defined $end and $end + $self->_chunk_true_start > $self->_chunk_true_end
!ll&&!rl&&r
451320
MC/DC0%0/3
defined $end and $end + $self->_chunk_true_start > $self->_chunk_true_end or not $end
defined $end $end + $self->_chunk_true_start > $self->_chunk_true_end not $end
Truth table40%2/5
A and B or not(C)
A= defined $endB= $end + $self->_chunk_true_start > $self->_chunk_true_endC= not $end
ABCresult
11X1
0X11
1011
0X00
1000
230 45 ▶ $start = $self->{_end_of_previous_hsp} || $self->{_after_header};
Condition66%2/3
$self->{'_end_of_previous_hsp'} || $self->{'_after_header'}
l!l&&r!l&&!r
28170
MC/DC0%0/2
$self->{'_end_of_previous_hsp'} || $self->{'_after_header'}
$self->{'_end_of_previous_hsp'} $self->{'_after_header'}
Truth table66%2/3
A || B
A= $self->{'_end_of_previous_hsp'}B= $self->{'_after_header'}
ABresult
1X1
011
000
231 45 $end = $self->_chunk_true_end;
232 }
233 else {
234 132 $end += $self->_chunk_true_start;
235 }
236 177 $start += $self->_chunk_true_start;
237
238 177 ▶ return if $start >= $self->_chunk_true_end;
Branch: 1 branch
BranchTrueFalseTotal
if $start >= $self->_chunk_true_end 32 145 177
239
240 145 $self->{_end_of_previous_hsp} = $end - $self->_chunk_true_start;
241
242 #*** needs to inherit piped_behaviour, and we need to deal with _sequential
243 # ourselves
244 145 $self->_fields->{next_hsp} = Bio::Search::HSP::BlastPullHSP->new(-parent => $self,
245 -chunk => [$self->chunk, $start, $end]);
246 }
247  
248 4 ▶sub _discover_num_hsps {
Subroutine _discover_num_hsps: called CC=1 SCAR=0.0
249 4 my $self = shift;
250 4 $self->_fields->{num_hsps} = $self->hsps;
251 }
252  
253 =head2 next_hsp
254  
255 Title : next_hsp
256 Usage : while( $hsp = $obj->next_hsp()) { ... }
257 Function : Returns the next available High Scoring Pair
258 Example :
259 Returns : L<Bio::Search::HSP::HSPI> object or null if finished
260 Args : none
261  
262 =cut
263  
264 177 ▶sub next_hsp {
Subroutine next_hsp: called CC=1 SCAR=0.0
Pod documented
265 177 my $self = shift;
266 177 my $hsp = $self->get_field('next_hsp');
267 177 undef $self->_fields->{next_hsp};
268 177 return $hsp;
269 }
270  
271 =head2 hsps
272  
273 Usage : $hit_object->hsps();
274 Purpose : Get a list containing all HSP objects.
275 Example : @hsps = $hit_object->hsps();
276 Returns : list of L<Bio::Search::HSP::BlastHSP> objects.
277 Argument : none
278  
279 =cut
280  
281 28 ▶sub hsps {
Subroutine hsps: called CC=2 SCAR=6.9
Pod documented
282 28 my $self = shift;
283 28 my $old = $self->{_end_of_previous_hsp};
284 28 $self->rewind;
285 28 my @hsps;
286 28 ▶ while (defined(my $hsp = $self->next_hsp)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $hsp = $self->next_hsp)) 140 28 168
287 140 push(@hsps, $hsp);
288 }
289 28 $self->{_end_of_previous_hsp} = $old;
290 28 return @hsps;
291 }
292  
293 =head2 hsp
294  
295 Usage : $hit_object->hsp( [string] );
296 Purpose : Get a single HSPI object for the present HitI object.
297 Example : $hspObj = $hit_object->hsp; # same as 'best'
298 : $hspObj = $hit_object->hsp('best');
299 : $hspObj = $hit_object->hsp('worst');
300 Returns : Object reference for a L<Bio::Search::HSP::HSPI> object.
301 Argument : String (or no argument).
302 : No argument (default) = highest scoring HSP (same as 'best').
303 : 'best' = highest scoring HSP.
304 : 'worst' = lowest scoring HSP.
305 Throws : Exception if an unrecognized argument is used.
306  
307 See Also : L<hsps()|hsps>, L<num_hsps>()
308  
309 =cut
310  
311 0 ▶sub hsp {
Subroutine hsp: not called CC=2 SCAR=17.9
Pod documented
312 0 my ($self, $type) = @_;
313 0 ▶ $type ||= 'best';
Condition0%0/2
$type ||= "best"
l!l
00
MC/DC0%0/1
$type ||= "best"
$type
Truth table0%0/2
A
A= $type
Aresult
11
00
314 0 $self->throw_not_implemented;
315 }
316  
317 =head2 rewind
318  
319 Title : rewind
320 Usage : $result->rewind;
321 Function: Allow one to reset the HSP iterator to the beginning, so that
322 next_hsp() will subsequently return the first hsp and so on.
323 Returns : n/a
324 Args : none
325  
326 =cut
327  
328 28 ▶sub rewind {
Subroutine rewind: called CC=1 SCAR=0.0
Pod documented
329 28 my $self = shift;
330 28 delete $self->{_end_of_previous_hsp};
331 }
332  
333 # have p() a synonym of significance()
334 0 ▶sub p {
Subroutine p: not called CC=1 SCAR=6.9
Pod documented
335 0 return shift->significance;
336 }
337  
338 4 1;
« Bio/Seq.pm ↑ Summary Bio/Tree/Tree.pm »