1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
#
# BioPerl module for Bio::Tools::Sim4::Exon
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Ewan Birney <birney-at-sanger.ac.uk>
# and Hilmar Lapp <hlapp-at-gmx.net>
#
# Copyright Ewan Birney, Hilmar Lapp
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Tools::Sim4::Exon - A single exon determined by an alignment
=head1 SYNOPSIS
# See Bio::Tools::Sim4::Results for a description of the context.
# an instance of this class is-a Bio::SeqFeature::SimilarityPair
# coordinates of the exon (recommended way):
print "exon from ", $exon->start(),
" to ", $exon->end(), "\n";
# the same (feature1() inherited from Bio::SeqFeature::FeaturePair)
print "exon from ", $exon->feature1()->start(),
" to ", $exon->feature1()->end(), "\n";
# also the same (query() inherited from Bio::SeqFeature::SimilarityPair):
print "exon from ", $exon->query()->start(),
" to ", $exon->query()->end(), "\n";
# coordinates on the matching EST (recommended way):
print "matches on EST from ", $exon->est_hit()->start(),
" to ", $exon->est_hit()->end(), "\n";
# the same (feature2() inherited from Bio::SeqFeature::FeaturePair)
print "matches on EST from ", $exon->feature2()->start(),
" to ", $exon->feature2()->end(), "\n";
# also the same (subject() inherited from Bio::SeqFeature::SimilarityPair):
print "exon from ", $exon->subject()->start(),
" to ", $exon->subject()->end(), "\n";
=head1 DESCRIPTION
This class inherits from Bio::SeqFeature::SimilarityPair and represents an
exon on a genomic sequence determined by similarity, that is, by aligning an
EST sequence (using Sim4 in this case). Consequently, the notion of query and
subject is always from the perspective of the genomic sequence: query refers
to the genomic seq, subject to the aligned EST hit. Because of this,
$exon-E<gt>start(), $exon-E<gt>end() etc will always return what you expect.
To get the coordinates on the matching EST, refer to the properties of the
feature returned by L<est_hit>().
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this
and other Bioperl modules. Send your comments and suggestions preferably
to one of the Bioperl mailing lists.
Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via the
web:
https://github.com/bioperl/bioperl-live/issues
=head1 AUTHOR - Ewan Birney, Hilmar Lapp
Ewan Birney E<lt>birney-at-sanger.ac.ukE<gt>
Hilmar Lapp E<lt>hlapp-at-gmx.netE<gt> or E<lt>hilmar.lapp-at-pharma.novartis.comE<gt>.
=head1 APPENDIX
The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::Tools::Sim4::Exon;
use strict;
use base qw(Bio::SeqFeature::SimilarityPair);
sub new {
my ($class,@args) = @_;
my %param = @args;
my $self = $class->SUPER::new(@args);
my ($prim, $prim_tag, $source, $source_tag) =
$self->_rearrange([qw(PRIMARY
PRIMARY_TAG
SOURCE
SOURCE_TAG)],
@args);
$self->primary_tag('exon') unless $prim || $prim_tag;
$self->source_tag('Sim4') unless $source || $source_tag;
$self->strand(0) unless defined($self->strand());
$self->query();
return $self;
}
=head2 percentage_id
Title : percentage_id
Usage : $obj->percentage_id($newval)
Function: This is a synonym for 100 * $obj->est_hit()->frac_identical().
Returns : value of percentage_id
Args : newvalue (optional)
=cut
sub percentage_id {
my ($self, @args) = @_;
my $frac;
my $val;
my $delegated = 0;
if(@args) {
$frac = $args[0];
$frac /= 100.0 if defined($frac);
}
if($self->query()->can('frac_identical')) {
if(defined($frac)) {
$self->query()->frac_identical($frac);
}
$val = 100.0 * $self->query()->frac_identical();
$delegated = 1;
}
if($self->est_hit()->can('frac_identical')) {
if(defined($frac)) {
$self->est_hit()->frac_identical($frac);
}
# this intentiously overwrites previous $val
$val = 100.0 * $self->est_hit()->frac_identical();
$delegated = 1;
}
if(! $delegated) {
if(@args) {
$val = shift(@args);
$self->{'percentage_id'} = $val;
} else {
$val = $self->{'percentage_id'};
}
}
return $val;
}
=head2 est_hit
Title : est_hit
Usage : $est_feature = $obj->est_hit();
Function: Returns the EST hit pointing to (i.e., aligned to by Sim4) this
exon (i.e., genomic region). At present, merely a synonym for
$obj->feature2().
Returns : An Bio::SeqFeatureI implementing object.
Args :
=cut
sub est_hit {
my $self = shift;
return $self->feature2(@_);
}
1;
|
