annotate variant_effect_predictor/Bio/Search/HSP/WABAHSP.pm @ 1:d6778b5d8382 draft default tip

Deleted selected files
author willmclaren
date Fri, 03 Aug 2012 10:05:43 -0400
parents 21066c0abaf5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 # $Id: WABAHSP.pm,v 1.5 2002/10/22 07:45:17 lapp Exp $
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 # BioPerl module for Bio::Search::HSP::WABAHSP
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 # Cared for by Jason Stajich <jason@bioperl.org>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 # Copyright Jason Stajich
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 # POD documentation - main docs before the code
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15 Bio::Search::HSP::WABAHSP - HSP object suitable for describing WABA alignments
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 # use this object as you would a GenericHSP
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 # a few other methods have been added including state
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 This object implements a few of the extra methods such as
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25 hmmstate_string which returns the HMM state representation for the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 WABA alignment. We also must implement a method to calculate
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27 homology_string since it is not returned by the algorithm in the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 machine readable format.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 =head1 FEEDBACK
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 =head2 Mailing Lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34 User feedback is an integral part of the evolution of this and other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 Bioperl modules. Send your comments and suggestions preferably to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 the Bioperl mailing list. Your participation is much appreciated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 bioperl-l@bioperl.org - General discussion
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 http://bioperl.org/MailList.shtml - About the mailing lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 =head2 Reporting Bugs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 Report bugs to the Bioperl bug tracking system to help us keep track
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 of the bugs and their resolution. Bug reports can be submitted via
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 email or the web:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 bioperl-bugs@bioperl.org
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 http://bugzilla.bioperl.org/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50 =head1 AUTHOR - Jason Stajich
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 Email jason@bioperl.org
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 Describe contact details here
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 =head1 CONTRIBUTORS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 Additional contributors names and emails here
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 =head1 APPENDIX
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 The rest of the documentation details each of the object methods.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 Internal methods are usually preceded with a _
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 package Bio::Search::HSP::WABAHSP;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 use Bio::Root::RootI;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 use Bio::Search::HSP::GenericHSP;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 @ISA = qw(Bio::Search::HSP::GenericHSP );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 =head2 new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 Title : new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 Usage : my $obj = new Bio::Search::HSP::WABAHSP();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 Function: Builds a new Bio::Search::HSP::WABAHSP object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 Returns : Bio::Search::HSP::WABAHSP
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 Args : -hmmstate_seq => the string representing the state output from WABA
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 my($class,@args) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 # gotta do some preprocessing before we send the arguments to the superclass
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92 my ($len,$qs,$hs) = Bio::Root::RootI->_rearrange([qw(HSP_LENGTH
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 QUERY_SEQ
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 HIT_SEQ)],@args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 if( $len != length($qs) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 Bio::Root::RootI->warn("HSP_LENGTH must equal length of query_seq string, using value from QUERY_SEQ\n");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 $len = length($qs);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 my( $homol_seq,$gapct,$identical) = ('',0,0);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 for(my $i=0;$i<$len;$i++) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 my $q = substr($qs,$i,1);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 my $h = substr($hs,$i,1);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 if( $q eq '-' || $h eq '-' ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 $homol_seq .= ' ';
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 $gapct ++;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 } elsif( $q eq $h ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 $homol_seq .= '|';
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 $identical++;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 } else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 $homol_seq .= ' ';
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 my $self = $class->SUPER::new('-conserved' => $identical,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 '-identical' => $identical,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116 '-gaps' => $gapct,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 '-homology_seq' => $homol_seq,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 @args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 my ($hmmst) = $self->_rearrange([qw(HMMSTATE_SEQ)],@args);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 defined $hmmst && $self->hmmstate_string($hmmst);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 $self->add_tag_value('Target' , join(" ","Sequence:".$self->hit->seq_id,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 $self->hit->start, $self->hit->end));
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 =head2 hmmstate_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 Title : hmmstate_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 Usage : my $hmmseq = $wabahsp->hmmstate_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 Function: Get/Set the WABA HMM stateseq
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 Returns : string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135 Args : [optional] string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 sub hmmstate_string{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 my ($self,$val) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 if( defined $val ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 $self->{'_hmmstate_string'} = $val;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145 return $self->{'_hmmstate_string'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148 =head2 homolgy_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
150 Title : homolgy_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
151 Usage : my $homology_str = $hsp->homology_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
152 Function: Homology string must be calculated for a WABA HSP so we can do
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
153 so here and cache the result so it is only done once
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
154 Returns : string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
155 Args : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
156
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
157
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
158 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
159
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
160 sub homolgy_string{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
161 my ($self) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
162 return '';
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
163 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
164
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
165
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
166 1;