annotate variant_effect_predictor/Bio/Search/Hit/GenericHit.pm @ 0:1f6dce3d34e0

Uploaded
author mahtabm
date Thu, 11 Apr 2013 02:01:53 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 # $Id: GenericHit.pm,v 1.20.2.1 2003/02/28 09:27:56 jason Exp $
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 # BioPerl module for Bio::Search::Hit::GenericHit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5 # Cared for by Jason Stajich <jason@bioperl.org>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 # Copyright Jason Stajich
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 # POD documentation - main docs before the code
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15 Bio::Search::Hit::GenericHit - A generic implementation of the Bio::Search::Hit::HitI interface
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 use Bio::Search::Hit::GenericHit;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20 my $hit = new Bio::Search::Hit::GenericHit(-algorithm => 'blastp');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22 # more likely
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 use Bio::SearchIO;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 my $parser = new Bio::SearchIO(-format => 'blast', -file => 'result.bls');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26 my $result = $parser->next_result;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 my $hit = $result->next_hit;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 This object handles the hit data from a Database Sequence Search such
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 as FASTA or BLAST.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 =head1 FEEDBACK
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 =head2 Mailing Lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 User feedback is an integral part of the evolution of this and other
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 Bioperl modules. Send your comments and suggestions preferably to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 the Bioperl mailing list. Your participation is much appreciated.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 bioperl-l@bioperl.org - General discussion
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 http://bioperl.org/MailList.shtml - About the mailing lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 =head2 Reporting Bugs
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 Report bugs to the Bioperl bug tracking system to help us keep track
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 of the bugs and their resolution. Bug reports can be submitted via
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 email or the web:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 bioperl-bugs@bioperl.org
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 http://bugzilla.bioperl.org/
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 =head1 AUTHOR - Jason Stajich and Steve Chervitz
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 Email jason@bioperl.org
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 Email sac@bioperl.org
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 =head1 CONTRIBUTORS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 Additional contributors names and emails here
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 =head1 APPENDIX
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 The rest of the documentation details each of the object methods.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 Internal methods are usually preceded with a _
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 # Let the code begin...
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 package Bio::Search::Hit::GenericHit;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 use vars qw(@ISA);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 use Bio::Root::Root;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 use Bio::Search::Hit::HitI;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 require Bio::Search::SearchUtils;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 @ISA = qw(Bio::Root::Root Bio::Search::Hit::HitI );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 =head2 new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 Title : new
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 Usage : my $obj = new Bio::Search::Hit::GenericHit();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 Function: Builds a new Bio::Search::Hit::GenericHit object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 Returns : Bio::Search::Hit::GenericHit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 Args : -name => Name of Hit (required)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 -description => Description (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 -accession => Accession number (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 -length => Length of the Hit (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 -score => Raw Score for the Hit (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 -significance => Significance value for the Hit (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 -algorithm => Algorithm used (BLASTP, FASTX, etc...)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 -hsps => Array ref of HSPs for this Hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 -iteration => integer for the PSI-Blast iteration number
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 my($class,@args) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 my $self = $class->SUPER::new(@args);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 my ($hsps, $name,$query_len,$desc, $acc, $locus, $length,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 $score,$algo,$signif,$bits,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 $iter,$rank) = $self->_rearrange([qw(HSPS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 QUERY_LEN
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 ACCESSION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114 LOCUS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 LENGTH SCORE ALGORITHM
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 SIGNIFICANCE BITS ITERATION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 RANK )], @args);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119 $self->{'_query_length'} = $query_len;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121 if( ! defined $name ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 $self->throw("Must have defined a valid name for Hit");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 $self->name($name);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127 defined $acc && $self->accession($acc);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128 defined $locus && $self->locus($locus);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129 defined $desc && $self->description($desc);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 defined $length && $self->length($length);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131 defined $algo && $self->algorithm($algo);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132 defined $signif && $self->significance($signif);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133 defined $score && $self->raw_score($score);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134 defined $bits && $self->bits($bits);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 defined $iter && $self->iteration($iter);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136 defined $rank && $self->rank($rank);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
137
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
138 $self->{'_iterator'} = 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
139 $self->{'_hsps'} = [];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
140 if( defined $hsps ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
141 if( ref($hsps) !~ /array/i ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
142 $self->warn("Did not specify a valid array ref for the param HSPS ($hsps)");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
143 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
144 while( @$hsps ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
145 $self->add_hsp(shift @$hsps );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
146 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
147 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
148 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
149 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
150 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
151
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
152 =head2 add_hsp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
153
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
154 Title : add_hsp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
155 Usage : $hit->add_hsp($hsp)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
156 Function: Add a HSP to the collection of HSPs for a Hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
157 Returns : number of HSPs in the Hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
158 Args : Bio::Search::HSP::HSPI object
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
159
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
160
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
161 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
162
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
163 sub add_hsp {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
164 my ($self,$hsp) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
165 if( !defined $hsp || ! $hsp->isa('Bio::Search::HSP::HSPI') ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
166 $self->warn("Must provide a valid Bio::Search::HSP::HSPI object to object: $self method: add_hsp value: $hsp");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
167 return undef;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
168 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
169 push @{$self->{'_hsps'}}, $hsp;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
170 return scalar @{$self->{'_hsps'}};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
171 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
172
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
173
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
174
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
175 =head2 Bio::Search::Hit::HitI methods
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
176
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
177 Implementation of Bio::Search::Hit::HitI methods
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
178
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
179 =head2 name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
180
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
181 Title : name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
182 Usage : $hit_name = $hit->name();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
183 Function: returns the name of the Hit sequence
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
184 Returns : a scalar string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
185 Args : [optional] scalar string to set the name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
186
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
187 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
188
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
189 sub name {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
190 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
191 my $previous = $self->{'_name'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
192 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
193 $value = $previous = '' unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
194 $self->{'_name'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
195 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
196 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
197 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
198
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
199 =head2 accession
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
200
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
201 Title : accession
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
202 Usage : $acc = $hit->accession();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
203 Function: Retrieve the accession (if available) for the hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
204 Returns : a scalar string (empty string if not set)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
205 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
206
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
207 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
208
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
209 sub accession {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
210 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
211 my $previous = $self->{'_accession'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
212 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
213 $value = $previous = '' unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
214 $self->{'_accession'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
215 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
216 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
217 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
218
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
219 =head2 description
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
220
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
221 Title : description
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
222 Usage : $desc = $hit->description();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
223 Function: Retrieve the description for the hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
224 Returns : a scalar string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
225 Args : [optional] scalar string to set the descrition
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
226
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
227 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
228
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
229 sub description {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
230 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
231 my $previous = $self->{'_description'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
232 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
233 $value = $previous = '' unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
234 $self->{'_description'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
235 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
236 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
237 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
238
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
239 =head2 length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
240
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
241 Title : length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
242 Usage : my $len = $hit->length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
243 Function: Returns the length of the hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
244 Returns : integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
245 Args : [optional] integer to set the length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
246
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
247 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
248
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
249 sub length {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
250 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
251 my $previous = $self->{'_length'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
252 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
253 $value = $previous = 0 unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
254 $self->{'_length'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
255 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
256 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
257 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
258
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
259
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
260 =head2 algorithm
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
261
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
262 Title : algorithm
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
263 Usage : $alg = $hit->algorithm();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
264 Function: Gets the algorithm specification that was used to obtain the hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
265 For BLAST, the algorithm denotes what type of sequence was aligned
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
266 against what (BLASTN: dna-dna, BLASTP prt-prt, BLASTX translated
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
267 dna-prt, TBLASTN prt-translated dna, TBLASTX translated
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
268 dna-translated dna).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
269 Returns : a scalar string
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
270 Args : [optional] scalar string to set the algorithm
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
271
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
272 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
273
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
274 sub algorithm {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
275 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
276 my $previous = $self->{'_algorithm'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
277 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
278 $value = $previous = '' unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
279 $self->{'_algorithm'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
280 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
281 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
282 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
283
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
284 =head2 raw_score
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
285
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
286 Title : raw_score
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
287 Usage : $score = $hit->raw_score();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
288 Function: Gets the "raw score" generated by the algorithm. What
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
289 this score is exactly will vary from algorithm to algorithm,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
290 returning undef if unavailable.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
291 Returns : a scalar value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
292 Args : [optional] scalar value to set the raw score
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
293
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
294 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
295
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
296 sub raw_score {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
297 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
298 my $previous = $self->{'_score'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
299 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
300 $value = $previous = '' unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
301 $self->{'_score'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
302 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
303 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
304 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
305
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
306 =head2 significance
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
307
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
308 Title : significance
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
309 Usage : $significance = $hit->significance();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
310 Function: Used to obtain the E or P value of a hit, i.e. the probability that
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
311 this particular hit was obtained purely by random chance. If
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
312 information is not available (nor calculatable from other
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
313 information sources), return undef.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
314 Returns : a scalar value or undef if unavailable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
315 Args : [optional] scalar value to set the significance
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
316
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
317 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
318
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
319 sub significance {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
320 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
321 my $previous = $self->{'_significance'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
322 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
323 $value = $previous = '' unless defined $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
324 $self->{'_significance'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
325 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
326 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
327 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
328
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
329 =head2 bits
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
330
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
331 Usage : $hit_object->bits();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
332 Purpose : Gets the bit score of the best HSP for the current hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
333 Example : $bits = $hit_object->bits();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
334 Returns : Integer or undef if bit score is not set
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
335 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
336 Comments : For BLAST1, the non-bit score is listed in the summary line.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
337
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
338 See Also : L<score()|score>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
339
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
340 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
341
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
342 #---------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
343 sub bits {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
344 #---------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
345 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
346
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
347 my $bits = $self->{'_bits'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
348 if( ! defined $bits ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
349 $bits = $self->{'_hsps'}->[0]->bits();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
350 $self->{'_bits'} = $bits;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
351 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
352 return $bits;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
353 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
354
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
355 =head2 next_hsp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
356
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
357 Title : next_hsp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
358 Usage : while( $hsp = $obj->next_hsp()) { ... }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
359 Function : Returns the next available High Scoring Pair
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
360 Example :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
361 Returns : Bio::Search::HSP::HSPI object or null if finished
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
362 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
363
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
364 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
365
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
366 sub next_hsp {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
367 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
368 $self->{'_iterator'} = 0 unless defined $self->{'_iterator'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
369 return undef if $self->{'_iterator'} > scalar @{$self->{'_hsps'}};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
370 return $self->{'_hsps'}->[$self->{'_iterator'}++];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
371 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
372
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
373
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
374 =head2 hsps
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
375
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
376 Usage : $hit_object->hsps();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
377 Purpose : Get a list containing all HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
378 : Get the numbers of HSPs for the current hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
379 Example : @hsps = $hit_object->hsps();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
380 : $num = $hit_object->hsps(); # alternatively, use num_hsps()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
381 Returns : Array context : list of Bio::Search::HSP::BlastHSP.pm objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
382 : Scalar context: integer (number of HSPs).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
383 : (Equivalent to num_hsps()).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
384 Argument : n/a. Relies on wantarray
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
385 Throws : Exception if the HSPs have not been collected.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
386
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
387 See Also : L<hsp()|hsp>, L<num_hsps()|num_hsps>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
388
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
389 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
390
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
391 #---------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
392 sub hsps {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
393 #---------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
394 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
395
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
396 if (not ref $self->{'_hsps'}) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
397 $self->throw("Can't get HSPs: data not collected.");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
398 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
399
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
400 return wantarray
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
401 # returning list containing all HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
402 ? @{$self->{'_hsps'}}
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
403 # returning number of HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
404 : scalar(@{$self->{'_hsps'}});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
405 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
406
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
407 =head2 num_hsps
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
408
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
409 Usage : $hit_object->num_hsps();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
410 Purpose : Get the number of HSPs for the present Blast hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
411 Example : $nhsps = $hit_object->num_hsps();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
412 Returns : Integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
413 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
414 Throws : Exception if the HSPs have not been collected.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
415
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
416 See Also : L<hsps()|hsps>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
417
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
418 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
419
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
420 #-------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
421 sub num_hsps {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
422 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
423
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
424 if (not defined $self->{'_hsps'}) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
425 $self->throw("Can't get HSPs: data not collected.");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
426 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
427
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
428 return scalar(@{$self->{'_hsps'}});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
429 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
430
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
431 =head2 rewind
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
432
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
433 Title : rewind
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
434 Usage : $hit->rewind;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
435 Function: Allow one to reset the HSP iteration to the beginning
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
436 Since this is an in-memory implementation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
437 Returns : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
438 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
439
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
440 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
441
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
442 sub rewind{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
443 my ($self) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
444 $self->{'_iterator'} = 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
445 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
446
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
447 =head2 iteration
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
448
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
449 Title : iteration
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
450 Usage : $obj->iteration($newval)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
451 Function: PSI-BLAST iteration
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
452 Returns : value of iteration
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
453 Args : newvalue (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
454
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
455
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
456 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
457
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
458 sub iteration{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
459 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
460 if( defined $value) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
461 $self->{'_psiblast_iteration'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
462 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
463 return $self->{'_psiblast_iteration'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
464
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
465 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
466
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
467
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
468 =head2 ambiguous_aln
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
469
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
470 Usage : $ambig_code = $hit_object->ambiguous_aln();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
471 Purpose : Sets/Gets ambiguity code data member.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
472 Example : (see usage)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
473 Returns : String = 'q', 's', 'qs', '-'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
474 : 'q' = query sequence contains overlapping sub-sequences
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
475 : while sbjct does not.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
476 : 's' = sbjct sequence contains overlapping sub-sequences
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
477 : while query does not.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
478 : 'qs' = query and sbjct sequence contains overlapping sub-sequences
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
479 : relative to each other.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
480 : '-' = query and sbjct sequence do not contains multiple domains
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
481 : relative to each other OR both contain the same distribution
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
482 : of similar domains.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
483 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
484 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
485 Status : Experimental
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
486
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
487 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
488
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
489 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
490 sub ambiguous_aln {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
491 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
492 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
493 if(@_) { $self->{'_ambiguous_aln'} = shift; }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
494 $self->{'_ambiguous_aln'} || '-';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
495 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
496
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
497 =head2 overlap
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
498
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
499 See documentation in L<Bio::Search::SearchUtils::overlap()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
500
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
501 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
502
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
503 #-------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
504 sub overlap {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
505 #-------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
506 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
507 if(@_) { $self->{'_overlap'} = shift; }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
508 defined $self->{'_overlap'} ? $self->{'_overlap'} : 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
509 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
510
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
511
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
512 =head2 n
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
513
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
514 Usage : $hit_object->n();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
515 Purpose : Gets the N number for the current hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
516 : This is the number of HSPs in the set which was ascribed
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
517 : the lowest P-value (listed on the description line).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
518 : This number is not the same as the total number of HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
519 : To get the total number of HSPs, use num_hsps().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
520 Example : $n = $hit_object->n();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
521 Returns : Integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
522 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
523 Throws : Exception if HSPs have not been set (BLAST2 reports).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
524 Comments : Note that the N parameter is not reported in gapped BLAST2.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
525 : Calling n() on such reports will result in a call to num_hsps().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
526 : The num_hsps() method will count the actual number of
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
527 : HSPs in the alignment listing, which may exceed N in
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
528 : some cases.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
529
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
530 See Also : L<num_hsps()|num_hsps>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
531
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
532 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
533
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
534 #-----
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
535 sub n {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
536 #-----
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
537 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
538
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
539 # The check for $self->{'_n'} is a remnant from the 'query' mode days
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
540 # in which the sbjct object would collect data from the description
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
541 # line only.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
542
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
543 my ($n);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
544 if(not defined($self->{'_n'})) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
545 $n = $self->hsp->n;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
546 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
547 $n = $self->{'_n'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
548 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
549 $n ||= $self->num_hsps;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
550
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
551 return $n;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
552 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
553
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
554 =head2 p
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
555
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
556 Usage : $hit_object->p( [format] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
557 Purpose : Get the P-value for the best HSP of the given BLAST hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
558 : (Note that P-values are not provided with NCBI Blast2 reports).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
559 Example : $p = $sbjct->p;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
560 : $p = $sbjct->p('exp'); # get exponent only.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
561 : ($num, $exp) = $sbjct->p('parts'); # split sci notation into parts
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
562 Returns : Float or scientific notation number (the raw P-value, DEFAULT).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
563 : Integer if format == 'exp' (the magnitude of the base 10 exponent).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
564 : 2-element list (float, int) if format == 'parts' and P-value
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
565 : is in scientific notation (See Comments).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
566 Argument : format: string of 'raw' | 'exp' | 'parts'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
567 : 'raw' returns value given in report. Default. (1.2e-34)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
568 : 'exp' returns exponent value only (34)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
569 : 'parts' returns the decimal and exponent as a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
570 : 2-element list (1.2, -34) (See Comments).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
571 Throws : Warns if no P-value is defined. Uses expect instead.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
572 Comments : Using the 'parts' argument is not recommended since it will not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
573 : work as expected if the P-value is not in scientific notation.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
574 : That is, floats are not converted into sci notation before
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
575 : splitting into parts.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
576
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
577 See Also : L<expect()|expect>, L<signif()|signif>, L<Bio::Search::SearchUtils::get_exponent()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
578
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
579 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
580
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
581 #--------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
582 sub p {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
583 #--------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
584 # Some duplication of logic for p(), expect() and signif() for the sake of performance.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
585 my ($self, $fmt) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
586
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
587 my $val = $self->{'_p'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
588
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
589 # $val can be zero.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
590 if(not defined $val) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
591 # P-value not defined, must be a NCBI Blast2 report.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
592 # Use expect instead.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
593 $self->warn( "P-value not defined. Using expect() instead.");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
594 $val = $self->{'_expect'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
595 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
596
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
597 return $val if not $fmt or $fmt =~ /^raw/i;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
598 ## Special formats: exponent-only or as list.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
599 return &Bio::Search::SearchUtils::get_exponent($val) if $fmt =~ /^exp/i;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
600 return (split (/eE/, $val)) if $fmt =~ /^parts/i;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
601
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
602 ## Default: return the raw P-value.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
603 return $val;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
604 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
605
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
606 =head2 hsp
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
607
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
608 Usage : $hit_object->hsp( [string] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
609 Purpose : Get a single HSPI object for the present HitI object.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
610 Example : $hspObj = $hit_object->hsp; # same as 'best'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
611 : $hspObj = $hit_object->hsp('best');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
612 : $hspObj = $hit_object->hsp('worst');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
613 Returns : Object reference for a Bio::Search::HSP::BlastHSP.pm object.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
614 Argument : String (or no argument).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
615 : No argument (default) = highest scoring HSP (same as 'best').
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
616 : 'best' or 'first' = highest scoring HSP.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
617 : 'worst' or 'last' = lowest scoring HSP.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
618 Throws : Exception if the HSPs have not been collected.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
619 : Exception if an unrecognized argument is used.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
620
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
621 See Also : L<hsps()|hsps>, L<num_hsps>()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
622
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
623 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
624
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
625 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
626 sub hsp {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
627 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
628 my( $self, $option ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
629 $option ||= 'best';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
630
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
631 if (not ref $self->{'_hsps'}) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
632 $self->throw("Can't get HSPs: data not collected.");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
633 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
634
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
635 my @hsps = @{$self->{'_hsps'}};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
636
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
637 return $hsps[0] if $option =~ /best|first|1/i;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
638 return $hsps[$#hsps] if $option =~ /worst|last/i;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
639
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
640 $self->throw("Can't get HSP for: $option\n" .
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
641 "Valid arguments: 'best', 'worst'");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
642 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
643
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
644 =head2 logical_length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
645
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
646 Usage : $hit_object->logical_length( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
647 : (mostly intended for internal use).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
648 Purpose : Get the logical length of the hit sequence.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
649 : If the Blast is a TBLASTN or TBLASTX, the returned length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
650 : is the length of the would-be amino acid sequence (length/3).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
651 : For all other BLAST flavors, this function is the same as length().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
652 Example : $len = $hit_object->logical_length();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
653 Returns : Integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
654 Argument : seq_type = 'query' or 'hit' or 'sbjct' (default = 'query')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
655 ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
656 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
657 Comments : This is important for functions like frac_aligned_query()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
658 : which need to operate in amino acid coordinate space when dealing
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
659 : with [T]BLAST[NX] type reports.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
660
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
661 See Also : L<length()|length>, L<frac_aligned_query()|frac_aligned_query>, L<frac_aligned_hit()|frac_aligned_hit>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
662
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
663 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
664
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
665 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
666 sub logical_length {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
667 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
668 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
669 my $seqType = shift || 'query';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
670 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
671
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
672 my $length;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
673
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
674 # For the sbjct, return logical sbjct length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
675 if( $seqType eq 'sbjct' ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
676 $length = $self->{'_logical_length'} || $self->{'_length'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
677 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
678 else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
679 # Otherwise, return logical query length
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
680 $length = $self->{'_query_length'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
681 $self->throw("Must have defined query_len") unless ( $length );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
682
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
683 # Adjust length based on BLAST flavor.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
684 if($self->algorithm =~ /T?BLASTX/ ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
685 $length /= 3;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
686 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
687 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
688 return $length;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
689 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
690
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
691 =head2 length_aln
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
692
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
693 Usage : $hit_object->length_aln( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
694 Purpose : Get the total length of the aligned region for query or sbjct seq.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
695 : This number will include all HSPs
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
696 Example : $len = $hit_object->length_aln(); # default = query
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
697 : $lenAln = $hit_object->length_aln('query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
698 Returns : Integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
699 Argument : seq_Type = 'query' or 'hit' or 'sbjct' (Default = 'query')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
700 ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
701 Throws : Exception if the argument is not recognized.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
702 Comments : This method will report the logical length of the alignment,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
703 : meaning that for TBLAST[NX] reports, the length is reported
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
704 : using amino acid coordinate space (i.e., nucleotides / 3).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
705 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
706 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
707 : already been tiled, they will be tiled first automatically..
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
708 : If you don't want the tiled data, iterate through each HSP
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
709 : calling length() on each (use hsps() to get all HSPs).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
710
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
711 See Also : L<length()|length>, L<frac_aligned_query()|frac_aligned_query>, L<frac_aligned_hit()|frac_aligned_hit>, L<gaps()|gaps>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>, L<Bio::Search::HSP::BlastHSP::length()|Bio::Search::HSP::BlastHSP>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
712
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
713 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
714
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
715 #---------------'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
716 sub length_aln {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
717 #---------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
718 my( $self, $seqType, $num ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
719
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
720 $seqType ||= 'query';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
721 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
722
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
723 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
724
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
725 if( defined $num) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
726 return $self->{'_length_aln_'.$seqType} = $num;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
727 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
728
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
729 my $data = $self->{'_length_aln_'.$seqType};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
730
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
731 ## If we don't have data, figure out what went wrong.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
732 if(!$data) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
733 $self->throw("Can't get length aln for sequence type \"$seqType\". " .
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
734 "Valid types are 'query', 'hit', 'sbjct' ('sbjct' = 'hit')");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
735 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
736 return $data;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
737 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
738
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
739 =head2 gaps
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
740
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
741 Usage : $hit_object->gaps( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
742 Purpose : Get the number of gaps in the aligned query, hit, or both sequences.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
743 : Data is summed across all HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
744 Example : $qgaps = $hit_object->gaps('query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
745 : $hgaps = $hit_object->gaps('hit');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
746 : $tgaps = $hit_object->gaps(); # default = total (query + hit)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
747 Returns : scalar context: integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
748 : array context without args: two-element list of integers
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
749 : (queryGaps, hitGaps)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
750 : Array context can be forced by providing an argument of 'list' or 'array'.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
751 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
752 : CAUTION: Calling this method within printf or sprintf is arrray context.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
753 : So this function may not give you what you expect. For example:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
754 : printf "Total gaps: %d", $hit->gaps();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
755 : Actually returns a two-element array, so what gets printed
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
756 : is the number of gaps in the query, not the total
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
757 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
758 Argument : seq_type: 'query' | 'hit' or 'sbjct' | 'total' | 'list' (default = 'total')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
759 ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
760 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
761 Comments : If you need data for each HSP, use hsps() and then interate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
762 : through each HSP object.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
763 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
764 : already been tiled, they will be tiled first automatically..
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
765 : Not relying on wantarray since that will fail in situations
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
766 : such as printf "%d", $hit->gaps() in which you might expect to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
767 : be printing the total gaps, but evaluates to array context.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
768
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
769 See Also : L<length_aln()|length_aln>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
770
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
771 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
772
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
773 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
774 sub gaps {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
775 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
776 my( $self, $seqType, $num ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
777
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
778 $seqType ||= (wantarray ? 'list' : 'total');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
779 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
780
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
781 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
782
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
783 $seqType = lc($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
784
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
785 if( defined $num ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
786 $self->throw("Can't set gaps for seqType '$seqType'. Must be 'query' or 'hit'\n") unless ($seqType eq 'sbjct' or $seqType eq 'query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
787
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
788 return $self->{'_gaps_'.$seqType} = $num;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
789 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
790 elsif($seqType =~ /list|array/i) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
791 return ($self->{'_gaps_query'}, $self->{'_gaps_sbjct'});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
792 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
793 elsif($seqType eq 'total') {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
794 return ($self->{'_gaps_query'} + $self->{'_gaps_sbjct'}) || 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
795 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
796 return $self->{'_gaps_'.$seqType} || 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
797 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
798 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
799
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
800
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
801 =head2 matches
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
802
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
803 See documentation in L<Bio::Search::Hit::HitI::matches()|Bio::Search::Hit::HitI>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
804
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
805 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
806
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
807 #---------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
808 sub matches {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
809 #---------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
810 my( $self, $arg1, $arg2) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
811 my(@data,$data);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
812
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
813 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
814
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
815 if(!$arg1) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
816 @data = ($self->{'_totalIdentical'}, $self->{'_totalConserved'});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
817
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
818 return @data if @data;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
819
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
820 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
821
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
822 if( defined $arg2 ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
823 $self->{'_totalIdentical'} = $arg1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
824 $self->{'_totalConserved'} = $arg2;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
825 return ( $arg1, $arg2 );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
826 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
827 elsif($arg1 =~ /^id/i) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
828 $data = $self->{'_totalIdentical'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
829 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
830 $data = $self->{'_totalConserved'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
831 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
832 return $data if $data;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
833 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
834
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
835 ## Something went wrong if we make it to here.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
836 $self->throw("Can't get identical or conserved data: no data.");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
837 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
838
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
839
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
840 =head2 start
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
841
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
842 Usage : $sbjct->start( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
843 Purpose : Gets the start coordinate for the query, sbjct, or both sequences
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
844 : in the BlastHit object. If there is more than one HSP, the lowest start
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
845 : value of all HSPs is returned.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
846 Example : $qbeg = $sbjct->start('query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
847 : $sbeg = $sbjct->start('hit');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
848 : ($qbeg, $sbeg) = $sbjct->start();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
849 Returns : scalar context: integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
850 : array context without args: list of two integers (queryStart, sbjctStart)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
851 : Array context can be "induced" by providing an argument of 'list' or 'array'.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
852 Argument : In scalar context: seq_type = 'query' or 'hit' or 'sbjct' (default = 'query')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
853 ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
854 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
855 Comments : This method requires that all HSPs be tiled. If there is more than one
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
856 : HSP and they have not already been tiled, they will be tiled first automatically..
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
857 : Remember that the start and end coordinates of all HSPs are
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
858 : normalized so that start < end. Strand information can be
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
859 : obtained by calling $hit->strand().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
860
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
861 See Also : L<end()|end>, L<range()|range>, L<strand()|strand>,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
862 L<Bio::Search::HSP::BlastHSP::start|Bio::Search::HSP::BlastHSP>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
863
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
864 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
865
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
866 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
867 sub start {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
868 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
869 my ($self, $seqType, $num) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
870
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
871 $seqType ||= (wantarray ? 'list' : 'query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
872 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
873
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
874 if( defined $num ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
875 $seqType = "_\L$seqType\E";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
876 return $self->{$seqType.'Start'} = $num;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
877 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
878
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
879 # If there is only one HSP, defer this call to the solitary HSP.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
880 if($self->num_hsps == 1) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
881 return $self->hsp->start($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
882 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
883 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
884 if($seqType =~ /list|array/i) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
885 return ($self->{'_queryStart'}, $self->{'_sbjctStart'});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
886 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
887 ## Sensitive to member name changes.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
888 $seqType = "_\L$seqType\E";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
889 return $self->{$seqType.'Start'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
890 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
891 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
892 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
893
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
894
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
895 =head2 end
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
896
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
897 Usage : $sbjct->end( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
898 Purpose : Gets the end coordinate for the query, sbjct, or both sequences
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
899 : in the BlastHit object. If there is more than one HSP, the largest end
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
900 : value of all HSPs is returned.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
901 Example : $qend = $sbjct->end('query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
902 : $send = $sbjct->end('hit');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
903 : ($qend, $send) = $sbjct->end();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
904 Returns : scalar context: integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
905 : array context without args: list of two integers (queryEnd, sbjctEnd)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
906 : Array context can be "induced" by providing an argument of 'list' or 'array'.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
907 Argument : In scalar context: seq_type = 'query' or 'sbjct'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
908 : (case insensitive). If not supplied, 'query' is used.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
909 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
910 Comments : This method requires that all HSPs be tiled. If there is more than one
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
911 : HSP and they have not already been tiled, they will be tiled first automatically..
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
912 : Remember that the start and end coordinates of all HSPs are
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
913 : normalized so that start < end. Strand information can be
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
914 : obtained by calling $hit->strand().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
915
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
916 See Also : L<start()|start>, L<range()|range>, L<strand()|strand>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
917
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
918 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
919
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
920 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
921 sub end {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
922 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
923 my ($self, $seqType, $num) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
924
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
925 $seqType ||= (wantarray ? 'list' : 'query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
926 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
927
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
928
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
929 if( defined $num ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
930 $seqType = "_\L$seqType\E";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
931 return $self->{$seqType.'Stop'} = $num;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
932 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
933
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
934 # If there is only one HSP, defer this call to the solitary HSP.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
935 if($self->num_hsps == 1) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
936 return $self->hsp->end($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
937 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
938 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
939 if($seqType =~ /list|array/i) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
940 return ($self->{'_queryStop'}, $self->{'_sbjctStop'});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
941 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
942 ## Sensitive to member name changes.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
943 $seqType = "_\L$seqType\E";
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
944 return $self->{$seqType.'Stop'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
945 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
946 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
947 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
948
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
949 =head2 range
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
950
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
951 Usage : $sbjct->range( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
952 Purpose : Gets the (start, end) coordinates for the query or sbjct sequence
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
953 : in the HSP alignment.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
954 Example : ($qbeg, $qend) = $sbjct->range('query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
955 : ($sbeg, $send) = $sbjct->range('hit');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
956 Returns : Two-element array of integers
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
957 Argument : seq_type = string, 'query' or 'hit' or 'sbjct' (default = 'query')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
958 ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
959 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
960
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
961 See Also : L<start()|start>, L<end()|end>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
962
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
963 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
964
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
965 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
966 sub range {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
967 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
968 my ($self, $seqType) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
969 $seqType ||= 'query';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
970 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
971 return ($self->start($seqType), $self->end($seqType));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
972 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
973
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
974
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
975 =head2 frac_identical
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
976
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
977 Usage : $hit_object->frac_identical( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
978 Purpose : Get the overall fraction of identical positions across all HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
979 : The number refers to only the aligned regions and does not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
980 : account for unaligned regions in between the HSPs, if any.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
981 Example : $frac_iden = $hit_object->frac_identical('query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
982 Returns : Float (2-decimal precision, e.g., 0.75).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
983 Argument : seq_type: 'query' | 'hit' or 'sbjct' | 'total'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
984 : default = 'query' (but see comments below).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
985 : ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
986 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
987 Comments : Different versions of Blast report different values for the total
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
988 : length of the alignment. This is the number reported in the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
989 : denominators in the stats section:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
990 : "Identical = 34/120 Positives = 67/120".
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
991 : NCBI BLAST uses the total length of the alignment (with gaps)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
992 : WU-BLAST uses the length of the query sequence (without gaps).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
993 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
994 : Therefore, when called with an argument of 'total',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
995 : this method will report different values depending on the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
996 : version of BLAST used. Total does NOT take into account HSP
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
997 : tiling, so it should not be used.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
998 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
999 : To get the fraction identical among only the aligned residues,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1000 : ignoring the gaps, call this method without an argument or
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1001 : with an argument of 'query' or 'hit'.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1002 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1003 : If you need data for each HSP, use hsps() and then iterate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1004 : through the HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1005 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1006 : already been tiled, they will be tiled first automatically.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1007
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1008 See Also : L<frac_conserved()|frac_conserved>, L<frac_aligned_query()|frac_aligned_query>, L<matches()|matches>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1009
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1010 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1011
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1012 #------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1013 sub frac_identical {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1014 #------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1015 my ($self, $seqType) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1016 $seqType ||= 'query';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1017 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1018
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1019 ## Sensitive to member name format.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1020 $seqType = lc($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1021
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1022 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1023
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1024 my $ident = $self->{'_totalIdentical'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1025 my $total = $self->{'_length_aln_'.$seqType};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1026 my $ratio = $ident / $total;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1027 my $ratio_rounded = sprintf( "%.3f", $ratio);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1028
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1029 # Round down iff normal rounding yields 1 (just like blast)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1030 $ratio_rounded = 0.999 if (($ratio_rounded == 1) && ($ratio < 1));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1031 return $ratio_rounded;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1032 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1033
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1034
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1035
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1036 =head2 frac_conserved
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1037
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1038 Usage : $hit_object->frac_conserved( [seq_type] );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1039 Purpose : Get the overall fraction of conserved positions across all HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1040 : The number refers to only the aligned regions and does not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1041 : account for unaligned regions in between the HSPs, if any.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1042 Example : $frac_cons = $hit_object->frac_conserved('hit');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1043 Returns : Float (2-decimal precision, e.g., 0.75).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1044 Argument : seq_type: 'query' | 'hit' or 'sbjct' | 'total'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1045 : default = 'query' (but see comments below).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1046 : ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1047 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1048 Comments : Different versions of Blast report different values for the total
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1049 : length of the alignment. This is the number reported in the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1050 : denominators in the stats section:
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1051 : "Positives = 34/120 Positives = 67/120".
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1052 : NCBI BLAST uses the total length of the alignment (with gaps)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1053 : WU-BLAST uses the length of the query sequence (without gaps).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1054 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1055 : Therefore, when called with an argument of 'total',
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1056 : this method will report different values depending on the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1057 : version of BLAST used. Total does NOT take into account HSP
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1058 : tiling, so it should not be used.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1059 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1060 : To get the fraction conserved among only the aligned residues,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1061 : ignoring the gaps, call this method without an argument or
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1062 : with an argument of 'query' or 'hit'.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1063 :
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1064 : If you need data for each HSP, use hsps() and then interate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1065 : through the HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1066 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1067 : already been tiled, they will be tiled first automatically.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1068
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1069 See Also : L<frac_identical()|frac_identical>, L<matches()|matches>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1070
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1071 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1072
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1073 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1074 sub frac_conserved {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1075 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1076 my ($self, $seqType) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1077 $seqType ||= 'query';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1078 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1079
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1080 ## Sensitive to member name format.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1081 $seqType = lc($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1082
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1083 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1084
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1085 my $consv = $self->{'_totalConserved'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1086 my $total = $self->{'_length_aln_'.$seqType};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1087 my $ratio = $consv / $total;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1088 my $ratio_rounded = sprintf( "%.3f", $ratio);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1089
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1090 # Round down iff normal rounding yields 1 (just like blast)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1091 $ratio_rounded = 0.999 if (($ratio_rounded == 1) && ($ratio < 1));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1092 return $ratio_rounded;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1093 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1094
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1095
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1096
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1097
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1098 =head2 frac_aligned_query
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1099
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1100 Usage : $hit_object->frac_aligned_query();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1101 Purpose : Get the fraction of the query sequence which has been aligned
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1102 : across all HSPs (not including intervals between non-overlapping
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1103 : HSPs).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1104 Example : $frac_alnq = $hit_object->frac_aligned_query();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1105 Returns : Float (2-decimal precision, e.g., 0.75).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1106 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1107 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1108 Comments : If you need data for each HSP, use hsps() and then interate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1109 : through the HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1110 : To compute the fraction aligned, the logical length of the query
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1111 : sequence is used, meaning that for [T]BLASTX reports, the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1112 : full length of the query sequence is converted into amino acids
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1113 : by dividing by 3. This is necessary because of the way
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1114 : the lengths of aligned sequences are computed.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1115 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1116 : already been tiled, they will be tiled first automatically.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1117
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1118 See Also : L<frac_aligned_hit()|frac_aligned_hit>, L<logical_length()|logical_length>, L<length_aln()|length_aln>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1119
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1120 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1121
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1122 #----------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1123 sub frac_aligned_query {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1124 #----------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1125 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1126
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1127 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1128
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1129 sprintf( "%.2f", $self->{'_length_aln_query'}/
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1130 $self->logical_length('query'));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1131 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1132
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1133
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1134
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1135 =head2 frac_aligned_hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1136
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1137 Usage : $hit_object->frac_aligned_hit();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1138 Purpose : Get the fraction of the hit (sbjct) sequence which has been aligned
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1139 : across all HSPs (not including intervals between non-overlapping
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1140 : HSPs).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1141 Example : $frac_alnq = $hit_object->frac_aligned_hit();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1142 Returns : Float (2-decimal precision, e.g., 0.75).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1143 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1144 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1145 Comments : If you need data for each HSP, use hsps() and then interate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1146 : through the HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1147 : To compute the fraction aligned, the logical length of the sbjct
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1148 : sequence is used, meaning that for TBLAST[NX] reports, the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1149 : full length of the sbjct sequence is converted into amino acids
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1150 : by dividing by 3. This is necessary because of the way
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1151 : the lengths of aligned sequences are computed.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1152 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1153 : already been tiled, they will be tiled first automatically.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1154
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1155 See Also : L<frac_aligned_query()|frac_aligned_query>, L<matches()|matches>, , L<logical_length()|logical_length>, L<length_aln()|length_aln>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1156
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1157 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1158
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1159 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1160 sub frac_aligned_hit {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1161 #--------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1162 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1163
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1164 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1165
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1166 sprintf( "%.2f", $self->{'_length_aln_sbjct'}/$self->logical_length('sbjct'));
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1167 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1168
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1169
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1170 ## These methods are being maintained for backward compatibility.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1171
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1172 =head2 frac_aligned_sbjct
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1173
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1174 Same as L<frac_aligned_hit()|frac_aligned_hit>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1175
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1176 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1177
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1178 #----------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1179 sub frac_aligned_sbjct { my $self=shift; $self->frac_aligned_hit(@_); }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1180 #----------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1181
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1182 =head2 num_unaligned_sbjct
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1183
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1184 Same as L<num_unaligned_hit()|num_unaligned_hit>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1185
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1186 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1187
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1188 #----------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1189 sub num_unaligned_sbjct { my $self=shift; $self->num_unaligned_hit(@_); }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1190 #----------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1191
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1192
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1193
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1194 =head2 num_unaligned_hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1195
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1196 Usage : $hit_object->num_unaligned_hit();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1197 Purpose : Get the number of the unaligned residues in the hit sequence.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1198 : Sums across all all HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1199 Example : $num_unaln = $hit_object->num_unaligned_hit();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1200 Returns : Integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1201 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1202 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1203 Comments : See notes regarding logical lengths in the comments for frac_aligned_hit().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1204 : They apply here as well.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1205 : If you need data for each HSP, use hsps() and then interate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1206 : through the HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1207 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1208 : already been tiled, they will be tiled first automatically..
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1209
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1210 See Also : L<num_unaligned_query()|num_unaligned_query>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>, L<frac_aligned_hit()|frac_aligned_hit>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1211
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1212 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1213
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1214 #---------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1215 sub num_unaligned_hit {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1216 #---------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1217 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1218
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1219 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1220
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1221 my $num = $self->logical_length('sbjct') - $self->{'_length_aln_sbjct'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1222 ($num < 0 ? 0 : $num );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1223 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1224
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1225
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1226 =head2 num_unaligned_query
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1227
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1228 Usage : $hit_object->num_unaligned_query();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1229 Purpose : Get the number of the unaligned residues in the query sequence.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1230 : Sums across all all HSPs.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1231 Example : $num_unaln = $hit_object->num_unaligned_query();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1232 Returns : Integer
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1233 Argument : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1234 Throws : n/a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1235 Comments : See notes regarding logical lengths in the comments for frac_aligned_query().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1236 : They apply here as well.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1237 : If you need data for each HSP, use hsps() and then interate
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1238 : through the HSP objects.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1239 : This method requires that all HSPs be tiled. If they have not
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1240 : already been tiled, they will be tiled first automatically..
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1241
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1242 See Also : L<num_unaligned_hit()|num_unaligned_hit>, L<frac_aligned_query()|frac_aligned_query>, L<Bio::Search::SearchUtils::tile_hsps()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1243
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1244 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1245
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1246 #-----------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1247 sub num_unaligned_query {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1248 #-----------------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1249 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1250
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1251 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1252
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1253 my $num = $self->logical_length('query') - $self->{'_length_aln_query'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1254 ($num < 0 ? 0 : $num );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1255 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1256
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1257
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1258
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1259 =head2 seq_inds
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1260
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1261 Usage : $hit->seq_inds( seq_type, class, collapse );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1262 Purpose : Get a list of residue positions (indices) across all HSPs
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1263 : for identical or conserved residues in the query or sbjct sequence.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1264 Example : @s_ind = $hit->seq_inds('query', 'identical');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1265 : @h_ind = $hit->seq_inds('hit', 'conserved');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1266 : @h_ind = $hit->seq_inds('hit', 'conserved', 1);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1267 Returns : Array of integers
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1268 : May include ranges if collapse is non-zero.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1269 Argument : [0] seq_type = 'query' or 'hit' or 'sbjct' (default = 'query')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1270 : ('sbjct' is synonymous with 'hit')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1271 : [1] class = 'identical' or 'conserved' (default = 'identical')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1272 : (can be shortened to 'id' or 'cons')
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1273 : (actually, anything not 'id' will evaluate to 'conserved').
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1274 : [2] collapse = boolean, if non-zero, consecutive positions are merged
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1275 : using a range notation, e.g., "1 2 3 4 5 7 9 10 11"
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1276 : collapses to "1-5 7 9-11". This is useful for
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1277 : consolidating long lists. Default = no collapse.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1278 Throws : n/a.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1279
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1280 See Also : L<Bio::Search::HSP::BlastHSP::seq_inds()|Bio::Search::HSP::BlastHSP>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1281
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1282 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1283
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1284 #-------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1285 sub seq_inds {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1286 #-------------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1287 my ($self, $seqType, $class, $collapse) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1288
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1289 $seqType ||= 'query';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1290 $class ||= 'identical';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1291 $collapse ||= 0;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1292
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1293 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1294
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1295 my (@inds, $hsp);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1296 foreach $hsp ($self->hsps) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1297 # This will merge data for all HSPs together.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1298 push @inds, $hsp->seq_inds($seqType, $class);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1299 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1300
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1301 # Need to remove duplicates and sort the merged positions.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1302 if(@inds) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1303 my %tmp = map { $_, 1 } @inds;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1304 @inds = sort {$a <=> $b} keys %tmp;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1305 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1306
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1307 $collapse ? &Bio::Search::SearchUtils::collapse_nums(@inds) : @inds;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1308 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1309
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1310
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1311 =head2 strand
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1312
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1313 See documentation in L<Bio::Search::SearchUtils::strand()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1314
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1315 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1316
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1317 #----------'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1318 sub strand {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1319 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1320 my ($self, $seqType, $strnd) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1321
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1322 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1323
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1324 $seqType ||= (wantarray ? 'list' : 'query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1325 $seqType = 'sbjct' if $seqType eq 'hit';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1326
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1327 $seqType = lc($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1328
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1329 if( defined $strnd ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1330 $self->throw("Can't set strand for seqType '$seqType'. Must be 'query' or 'hit'\n") unless ($seqType eq 'sbjct' or $seqType eq 'query');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1331
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1332 return $self->{'_strand_'.$seqType} = $strnd;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1333 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1334
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1335 my ($qstr, $hstr);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1336 # If there is only one HSP, defer this call to the solitary HSP.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1337 if($self->num_hsps == 1) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1338 return $self->hsp->strand($seqType);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1339 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1340 elsif( defined $self->{'_strand_query'}) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1341 # Get the data computed during hsp tiling.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1342 $qstr = $self->{'_strand_query'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1343 $hstr = $self->{'_strand_sbjct'}
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1344 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1345 else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1346 # otherwise, iterate through all HSPs collecting strand info.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1347 # This will return the string "-1/1" if there are HSPs on different strands.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1348 # NOTE: This was the pre-10/21/02 procedure which will no longer be used,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1349 # (unless the above elsif{} is commented out).
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1350 my (%qstr, %hstr);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1351 foreach my $hsp( $self->hsps ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1352 my ( $q, $h ) = $hsp->strand();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1353 $qstr{ $q }++;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1354 $hstr{ $h }++;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1355 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1356 $qstr = join( '/', sort keys %qstr);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1357 $hstr = join( '/', sort keys %hstr);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1358 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1359
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1360 if($seqType =~ /list|array/i) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1361 return ($qstr, $hstr);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1362 } elsif( $seqType eq 'query' ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1363 return $qstr;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1364 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1365 return $hstr;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1366 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1367 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1368
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1369 =head2 frame
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1370
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1371 See documentation in L<Bio::Search::SearchUtils::frame()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1372
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1373 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1374
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1375 #----------'
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1376 sub frame {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1377 #----------
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1378 my( $self, $frm ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1379
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1380 Bio::Search::SearchUtils::tile_hsps($self) if not $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1381
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1382 if( defined $frm ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1383 return $self->{'_frame'} = $frm;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1384 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1385
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1386 # The check for $self->{'_frame'} is a remnant from the 'query' mode days
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1387 # in which the sbjct object would collect data from the description line only.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1388
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1389 my ($frame);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1390 if(not defined($self->{'_frame'})) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1391 $frame = $self->hsp->frame;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1392 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1393 $frame = $self->{'_frame'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1394 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1395 return $frame;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1396 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1397
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1398 =head2 rank
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1399
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1400 Title : rank
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1401 Usage : $obj->rank($newval)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1402 Function: Get/Set the rank of this Hit in the Query search list
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1403 i.e. this is the Nth hit for a specific query
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1404 Returns : value of rank
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1405 Args : newvalue (optional)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1406
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1407
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1408 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1409
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1410 sub rank{
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1411 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1412 return $self->{'_rank'} = shift if @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1413 return $self->{'_rank'} || 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1414 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1415
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1416 =head2 locus
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1417
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1418 Title : locus
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1419 Usage : $locus = $hit->locus();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1420 Function: Retrieve the locus (if available) for the hit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1421 Returns : a scalar string (empty string if not set)
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1422 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1423
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1424 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1425
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1426 sub locus {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1427 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1428 my $previous = $self->{'_locus'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1429 if( defined $value || ! defined $previous ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1430 unless (defined $value) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1431 if ($self->{'_name'} =~/(gb|emb|dbj|ref)\|(.*)\|(.*)/) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1432 $value = $previous = $3;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1433 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1434 $value = $previous = '';
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1435 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1436 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1437 $self->{'_locus'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1438 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1439 return $previous;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1440 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1441
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1442 =head2 each_accession_number
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1443
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1444 Title : each_accession_number
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1445 Usage : @each_accession_number = $hit->each_accession_number();
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1446 Function: Get each accession number listed in the description of the hit.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1447 If there are no alternatives, then only the primary accession will
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1448 be given
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1449 Returns : list of all accession numbers in the description
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1450 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1451
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1452 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1453
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1454 sub each_accession_number {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1455 my ($self,$value) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1456 my $desc = $self->{'_description'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1457 #put primary accnum on the list
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1458 my @accnums;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1459 push (@accnums,$self->{'_accession'});
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1460 if( defined $desc ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1461 while ($desc =~ /(\b\S+\|\S*\|\S*\s?)/g) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1462 my $id = $1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1463 my ($acc, $version);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1464 if ($id =~ /(gb|emb|dbj|sp|pdb|bbs|ref|lcl)\|(.*)\|(.*)/) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1465 ($acc, $version) = split /\./, $2;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1466 } elsif ($id =~ /(pir|prf|pat|gnl)\|(.*)\|(.*)/) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1467 ($acc, $version) = split /\./, $3;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1468 } else {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1469 #punt, not matching the db's at ftp://ftp.ncbi.nih.gov/blast/db/README
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1470 #Database Name Identifier Syntax
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1471 #============================ ========================
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1472 #GenBank gb|accession|locus
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1473 #EMBL Data Library emb|accession|locus
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1474 #DDBJ, DNA Database of Japan dbj|accession|locus
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1475 #NBRF PIR pir||entry
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1476 #Protein Research Foundation prf||name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1477 #SWISS-PROT sp|accession|entry name
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1478 #Brookhaven Protein Data Bank pdb|entry|chain
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1479 #Patents pat|country|number
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1480 #GenInfo Backbone Id bbs|number
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1481 #General database identifier gnl|database|identifier
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1482 #NCBI Reference Sequence ref|accession|locus
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1483 #Local Sequence identifier lcl|identifier
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1484 $acc=$id;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1485 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1486 push(@accnums, $acc);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1487 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1488 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1489 return @accnums;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1490 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1491
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1492 =head2 tiled_hsps
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1493
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1494 See documentation in L<Bio::Search::SearchUtils::tiled_hsps()|Bio::Search::SearchUtils>
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1495
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1496 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1497
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1498 sub tiled_hsps {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1499 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1500 return $self->{'_tiled_hsps'} = shift if @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1501 return $self->{'_tiled_hsps'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1502 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1503
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1504 1;