| 1 | # | ||||||||||||||||||||||||||||
| 2 | # BioPerl module for Bio::SeqFeature::FeaturePair | ||||||||||||||||||||||||||||
| 3 | # | ||||||||||||||||||||||||||||
| 4 | # Please direct questions and support issues to <bioperl-l@bioperl.org> | ||||||||||||||||||||||||||||
| 5 | # | ||||||||||||||||||||||||||||
| 6 | # Cared for by Ewan Birney <birney@sanger.ac.uk> | ||||||||||||||||||||||||||||
| 7 | # | ||||||||||||||||||||||||||||
| 8 | # Copyright Ewan Birney | ||||||||||||||||||||||||||||
| 9 | # | ||||||||||||||||||||||||||||
| 10 | # You may distribute this module under the same terms as perl itself | ||||||||||||||||||||||||||||
| 11 | |||||||||||||||||||||||||||||
| 12 | # POD documentation - main docs before the code | ||||||||||||||||||||||||||||
| 13 | |||||||||||||||||||||||||||||
| 14 | =head1 NAME | ||||||||||||||||||||||||||||
| 15 | |||||||||||||||||||||||||||||
| 16 | Bio::SeqFeature::FeaturePair - hold pair feature information e.g. blast hits | ||||||||||||||||||||||||||||
| 17 | |||||||||||||||||||||||||||||
| 18 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||
| 19 | |||||||||||||||||||||||||||||
| 20 | my $feat = Bio::SeqFeature::FeaturePair->new( | ||||||||||||||||||||||||||||
| 21 | -feature1 => $f1, | ||||||||||||||||||||||||||||
| 22 | -feature2 => $f2, | ||||||||||||||||||||||||||||
| 23 | ); | ||||||||||||||||||||||||||||
| 24 | |||||||||||||||||||||||||||||
| 25 | # Bio::SeqFeatureI methods can be used | ||||||||||||||||||||||||||||
| 26 | |||||||||||||||||||||||||||||
| 27 | my $start = $feat->start; | ||||||||||||||||||||||||||||
| 28 | my $end = $feat->end; | ||||||||||||||||||||||||||||
| 29 | |||||||||||||||||||||||||||||
| 30 | # Bio::FeaturePair methods can be used | ||||||||||||||||||||||||||||
| 31 | my $hstart = $feat->hstart; | ||||||||||||||||||||||||||||
| 32 | my $hend = $feat->hend; | ||||||||||||||||||||||||||||
| 33 | |||||||||||||||||||||||||||||
| 34 | my $feature1 = $feat->feature1; # returns feature1 object | ||||||||||||||||||||||||||||
| 35 | |||||||||||||||||||||||||||||
| 36 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 37 | |||||||||||||||||||||||||||||
| 38 | A sequence feature object where the feature is itself a feature on | ||||||||||||||||||||||||||||
| 39 | another sequence - e.g. a blast hit where residues 1-40 of a protein | ||||||||||||||||||||||||||||
| 40 | sequence SW:HBA_HUMAN has hit to bases 100 - 220 on a genomic sequence | ||||||||||||||||||||||||||||
| 41 | HS120G22. The genomic sequence coordinates are used to create one | ||||||||||||||||||||||||||||
| 42 | sequence feature $f1 and the protein coordinates are used to create | ||||||||||||||||||||||||||||
| 43 | feature $f2. A FeaturePair object can then be made | ||||||||||||||||||||||||||||
| 44 | |||||||||||||||||||||||||||||
| 45 | my $fp = Bio::SeqFeature::FeaturePair->new( | ||||||||||||||||||||||||||||
| 46 | -feature1 => $f1, # genomic | ||||||||||||||||||||||||||||
| 47 | -feature2 => $f2, # protein | ||||||||||||||||||||||||||||
| 48 | ); | ||||||||||||||||||||||||||||
| 49 | |||||||||||||||||||||||||||||
| 50 | This object can be used as a standard Bio::SeqFeatureI in which case | ||||||||||||||||||||||||||||
| 51 | |||||||||||||||||||||||||||||
| 52 | my $gstart = $fp->start # returns start coord on feature1 - genomic seq. | ||||||||||||||||||||||||||||
| 53 | my $gend = $fp->end # returns end coord on feature1. | ||||||||||||||||||||||||||||
| 54 | |||||||||||||||||||||||||||||
| 55 | In general standard Bio::SeqFeatureI method calls return information | ||||||||||||||||||||||||||||
| 56 | in feature1. | ||||||||||||||||||||||||||||
| 57 | |||||||||||||||||||||||||||||
| 58 | Data in the feature 2 object are generally obtained using the standard | ||||||||||||||||||||||||||||
| 59 | methods prefixed by h (for hit!) | ||||||||||||||||||||||||||||
| 60 | |||||||||||||||||||||||||||||
| 61 | my $pstart = $fp->hstart # returns start coord on feature2 = protein seq. | ||||||||||||||||||||||||||||
| 62 | my $pend = $fp->hend # returns end coord on feature2. | ||||||||||||||||||||||||||||
| 63 | |||||||||||||||||||||||||||||
| 64 | If you wish to swap feature1 and feature2 around : | ||||||||||||||||||||||||||||
| 65 | |||||||||||||||||||||||||||||
| 66 | $feat->invert | ||||||||||||||||||||||||||||
| 67 | |||||||||||||||||||||||||||||
| 68 | so... | ||||||||||||||||||||||||||||
| 69 | |||||||||||||||||||||||||||||
| 70 | $feat->start # etc. returns data in $feature2 object | ||||||||||||||||||||||||||||
| 71 | |||||||||||||||||||||||||||||
| 72 | |||||||||||||||||||||||||||||
| 73 | No sub_SeqFeatures or tags can be stored in this object directly. Any | ||||||||||||||||||||||||||||
| 74 | features or tags are expected to be stored in the contained objects | ||||||||||||||||||||||||||||
| 75 | feature1, and feature2. | ||||||||||||||||||||||||||||
| 76 | |||||||||||||||||||||||||||||
| 77 | =head1 CONTACT | ||||||||||||||||||||||||||||
| 78 | |||||||||||||||||||||||||||||
| 79 | Ewan Birney E<lt>birney@sanger.ac.ukE<gt> | ||||||||||||||||||||||||||||
| 80 | |||||||||||||||||||||||||||||
| 81 | =head1 APPENDIX | ||||||||||||||||||||||||||||
| 82 | |||||||||||||||||||||||||||||
| 83 | The rest of the documentation details each of the object | ||||||||||||||||||||||||||||
| 84 | methods. Internal methods are usually preceded with a _ | ||||||||||||||||||||||||||||
| 85 | |||||||||||||||||||||||||||||
| 86 | =cut | ||||||||||||||||||||||||||||
| 87 | |||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||
| 89 | # Let the code begin... | ||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||
| 91 | |||||||||||||||||||||||||||||
| 92 | package Bio::SeqFeature::FeaturePair; | ||||||||||||||||||||||||||||
| 93 | 77 | $Bio::SeqFeature::FeaturePair::VERSION = '1.7.8'; | |||||||||||||||||||||||||||
| 94 | 77 | ▶ | use vars qw($AUTOLOAD); | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 95 | 77 | ▶ | use strict; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 96 | |||||||||||||||||||||||||||||
| 97 | 77 | ▶ | use Bio::SeqFeatureI; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 98 | 77 | ▶ | use Bio::Factory::ObjectFactory; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 99 | |||||||||||||||||||||||||||||
| 100 | 77 | ▶ | use base qw(Bio::SeqFeature::Generic); | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 101 | |||||||||||||||||||||||||||||
| 102 | =head2 new | ||||||||||||||||||||||||||||
| 103 | |||||||||||||||||||||||||||||
| 104 | Title : new | ||||||||||||||||||||||||||||
| 105 | Usage : | ||||||||||||||||||||||||||||
| 106 | Function: Constructor for this module. Accepts the following parameters: | ||||||||||||||||||||||||||||
| 107 | |||||||||||||||||||||||||||||
| 108 | -feature1 Bio::SeqFeatureI-compliant object | ||||||||||||||||||||||||||||
| 109 | -feature2 Bio::SeqFeatureI-compliant object | ||||||||||||||||||||||||||||
| 110 | -feature_factory Bio::Factory::ObjectFactoryI compliant | ||||||||||||||||||||||||||||
| 111 | object to be used when feature1 and/or feature2 | ||||||||||||||||||||||||||||
| 112 | are accessed without explicitly set before. This | ||||||||||||||||||||||||||||
| 113 | is mostly useful for derived classes who want to | ||||||||||||||||||||||||||||
| 114 | set their preferred class for feature objects. | ||||||||||||||||||||||||||||
| 115 | |||||||||||||||||||||||||||||
| 116 | Example : | ||||||||||||||||||||||||||||
| 117 | Returns : | ||||||||||||||||||||||||||||
| 118 | Args : see above | ||||||||||||||||||||||||||||
| 119 | |||||||||||||||||||||||||||||
| 120 | |||||||||||||||||||||||||||||
| 121 | =cut | ||||||||||||||||||||||||||||
| 122 | |||||||||||||||||||||||||||||
| 123 | 1386 | ▶ | sub new { | ||||||||||||||||||||||||||
|
Subroutine
new: called CC=4 SCAR=13.9
Pod
documented
| |||||||||||||||||||||||||||||
| 124 | 1386 | my ($class, @args) = @_; | |||||||||||||||||||||||||||
| 125 | |||||||||||||||||||||||||||||
| 126 | # | ||||||||||||||||||||||||||||
| 127 | # We've got a certain problem here that somewhat relates to chicken and | ||||||||||||||||||||||||||||
| 128 | # eggs. The problem is, we override a lot of SeqFeatureI methods here | ||||||||||||||||||||||||||||
| 129 | # to delegate them to either feature1 or feature2. If we pass along | ||||||||||||||||||||||||||||
| 130 | # those attributes right away, we need feature1 or feature2 or the feature | ||||||||||||||||||||||||||||
| 131 | # factory in place, or there is no way around the dreaded default, which | ||||||||||||||||||||||||||||
| 132 | # is ugly too (as it necessitates subsequent copying if you wanted a | ||||||||||||||||||||||||||||
| 133 | # different feature object class). | ||||||||||||||||||||||||||||
| 134 | # | ||||||||||||||||||||||||||||
| 135 | # So I decided to go with the lesser of two evils here: we need to assume | ||||||||||||||||||||||||||||
| 136 | # here that we can set all attributes through set_attributes(), which we | ||||||||||||||||||||||||||||
| 137 | # assume is no different from setting them through the constructor. This | ||||||||||||||||||||||||||||
| 138 | # gives us a window to set the feature objects and the factory, such that | ||||||||||||||||||||||||||||
| 139 | # any derived class doesn't have to worry about this any more. | ||||||||||||||||||||||||||||
| 140 | # | ||||||||||||||||||||||||||||
| 141 | # I'm happy to hear a better solution, but I think this one isn't so bad. | ||||||||||||||||||||||||||||
| 142 | # | ||||||||||||||||||||||||||||
| 143 | 1386 | my $self = $class->SUPER::new(); | |||||||||||||||||||||||||||
| 144 | 1386 | my ($feature1,$feature2,$featfact) = | |||||||||||||||||||||||||||
| 145 | $self->_rearrange([qw( FEATURE1 | ||||||||||||||||||||||||||||
| 146 | FEATURE2 | ||||||||||||||||||||||||||||
| 147 | FEATURE_FACTORY )],@args); | ||||||||||||||||||||||||||||
| 148 | |||||||||||||||||||||||||||||
| 149 | 1386 | $self->_register_for_cleanup(\&cleanup_fp); | |||||||||||||||||||||||||||
| 150 | # initialize the feature object factory if not provided | ||||||||||||||||||||||||||||
| 151 | 1386 | ▶ | if(! $featfact) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 152 | 134 | $featfact = Bio::Factory::ObjectFactory->new( | |||||||||||||||||||||||||||
| 153 | -type => "Bio::SeqFeature::Generic", | ||||||||||||||||||||||||||||
| 154 | -interface => "Bio::SeqFeatureI" | ||||||||||||||||||||||||||||
| 155 | ); | ||||||||||||||||||||||||||||
| 156 | } | ||||||||||||||||||||||||||||
| 157 | 1386 | $self->feature_factory($featfact); | |||||||||||||||||||||||||||
| 158 | # Store the features in the object | ||||||||||||||||||||||||||||
| 159 | 1386 | ▶ | $feature1 && $self->feature1($feature1); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 160 | 1386 | ▶ | $feature2 && $self->feature2($feature2); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 161 | |||||||||||||||||||||||||||||
| 162 | # OK. Now we're setup to store all the attributes, and they'll go right | ||||||||||||||||||||||||||||
| 163 | # away into the right objects. | ||||||||||||||||||||||||||||
| 164 | 1386 | $self->set_attributes(@args); | |||||||||||||||||||||||||||
| 165 | |||||||||||||||||||||||||||||
| 166 | # done - we hope | ||||||||||||||||||||||||||||
| 167 | 1386 | return $self; | |||||||||||||||||||||||||||
| 168 | } | ||||||||||||||||||||||||||||
| 169 | |||||||||||||||||||||||||||||
| 170 | =head2 feature1 | ||||||||||||||||||||||||||||
| 171 | |||||||||||||||||||||||||||||
| 172 | Title : feature1 | ||||||||||||||||||||||||||||
| 173 | Usage : $f = $featpair->feature1 | ||||||||||||||||||||||||||||
| 174 | $featpair->feature1($feature) | ||||||||||||||||||||||||||||
| 175 | Function: Get/set for the query feature | ||||||||||||||||||||||||||||
| 176 | Returns : Bio::SeqFeatureI | ||||||||||||||||||||||||||||
| 177 | Args : Bio::SeqFeatureI | ||||||||||||||||||||||||||||
| 178 | |||||||||||||||||||||||||||||
| 179 | |||||||||||||||||||||||||||||
| 180 | =cut | ||||||||||||||||||||||||||||
| 181 | |||||||||||||||||||||||||||||
| 182 | 6967 | ▶ | sub feature1 { | ||||||||||||||||||||||||||
|
Subroutine
feature1: called CC=7 SCAR=19.9
Pod
documented
| |||||||||||||||||||||||||||||
| 183 | 6967 | my ($self,$arg) = @_; | |||||||||||||||||||||||||||
| 184 | 6967 | ▶ | if ( defined($arg) || !defined $self->{'feature1'} ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition100%3/3
defined $arg or not defined $self->{"feature1"}
MC/DC100%2/2
defined $arg or not defined $self->{"feature1"}
defined $arg
not defined $self->{"feature1"}
Truth table100%3/3
A or not(B)
A= defined $argB= not defined $self->{"feature1"}
| |||||||||||||||||||||||||||||
| 185 | 1388 | ▶ | $self->throw("internal error: feature factory not set!") | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 186 | unless $self->feature_factory; | ||||||||||||||||||||||||||||
| 187 | 1388 | ▶ | $arg = $self->feature_factory->create_object() unless( defined $arg); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 188 | 1388 | ▶ | $self->throw("Argument [$arg] must be a Bio::SeqFeatureI") | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
ref $arg and $arg->isa("Bio::SeqFeatureI")
MC/DC0%0/2
ref $arg and $arg->isa("Bio::SeqFeatureI")
ref $arg
$arg->isa("Bio::SeqFeatureI")
Truth table33%1/3
A and B
A= ref $argB= $arg->isa("Bio::SeqFeatureI")
| |||||||||||||||||||||||||||||
| 189 | unless (ref($arg) && $arg->isa("Bio::SeqFeatureI")); | ||||||||||||||||||||||||||||
| 190 | 1388 | $self->{'feature1'} = $arg; | |||||||||||||||||||||||||||
| 191 | } | ||||||||||||||||||||||||||||
| 192 | 6967 | return $self->{'feature1'}; | |||||||||||||||||||||||||||
| 193 | } | ||||||||||||||||||||||||||||
| 194 | |||||||||||||||||||||||||||||
| 195 | =head2 feature2 | ||||||||||||||||||||||||||||
| 196 | |||||||||||||||||||||||||||||
| 197 | Title : feature2 | ||||||||||||||||||||||||||||
| 198 | Usage : $f = $featpair->feature2 | ||||||||||||||||||||||||||||
| 199 | $featpair->feature2($feature) | ||||||||||||||||||||||||||||
| 200 | Function: Get/set for the hit feature | ||||||||||||||||||||||||||||
| 201 | Returns : Bio::SeqFeatureI | ||||||||||||||||||||||||||||
| 202 | Args : Bio::SeqFeatureI | ||||||||||||||||||||||||||||
| 203 | |||||||||||||||||||||||||||||
| 204 | |||||||||||||||||||||||||||||
| 205 | =cut | ||||||||||||||||||||||||||||
| 206 | |||||||||||||||||||||||||||||
| 207 | 4635 | ▶ | sub feature2 { | ||||||||||||||||||||||||||
|
Subroutine
feature2: called CC=7 SCAR=19.9
Pod
documented
| |||||||||||||||||||||||||||||
| 208 | 4635 | my ($self,$arg) = @_; | |||||||||||||||||||||||||||
| 209 | |||||||||||||||||||||||||||||
| 210 | 4635 | ▶ | if ( defined($arg) || ! defined $self->{'feature2'}) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition100%3/3
defined $arg or not defined $self->{"feature2"}
MC/DC100%2/2
defined $arg or not defined $self->{"feature2"}
defined $arg
not defined $self->{"feature2"}
Truth table100%3/3
A or not(B)
A= defined $argB= not defined $self->{"feature2"}
| |||||||||||||||||||||||||||||
| 211 | 642 | ▶ | $self->throw("internal error: feature factory not set!") | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 212 | unless $self->feature_factory; | ||||||||||||||||||||||||||||
| 213 | 642 | ▶ | $arg = $self->feature_factory->create_object() unless( defined $arg); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 214 | 642 | ▶ | $self->throw("Argument [$arg] must be a Bio::SeqFeatureI") | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
ref $arg and $arg->isa("Bio::SeqFeatureI")
MC/DC0%0/2
ref $arg and $arg->isa("Bio::SeqFeatureI")
ref $arg
$arg->isa("Bio::SeqFeatureI")
Truth table33%1/3
A and B
A= ref $argB= $arg->isa("Bio::SeqFeatureI")
| |||||||||||||||||||||||||||||
| 215 | unless (ref($arg) && $arg->isa("Bio::SeqFeatureI")); | ||||||||||||||||||||||||||||
| 216 | 642 | $self->{'feature2'} = $arg; | |||||||||||||||||||||||||||
| 217 | } | ||||||||||||||||||||||||||||
| 218 | 4635 | return $self->{'feature2'}; | |||||||||||||||||||||||||||
| 219 | } | ||||||||||||||||||||||||||||
| 220 | |||||||||||||||||||||||||||||
| 221 | =head2 start | ||||||||||||||||||||||||||||
| 222 | |||||||||||||||||||||||||||||
| 223 | Title : start | ||||||||||||||||||||||||||||
| 224 | Usage : $start = $featpair->start | ||||||||||||||||||||||||||||
| 225 | $featpair->start(20) | ||||||||||||||||||||||||||||
| 226 | Function: Get/set on the start coordinate of feature1 | ||||||||||||||||||||||||||||
| 227 | Returns : integer | ||||||||||||||||||||||||||||
| 228 | Args : [optional] beginning of feature | ||||||||||||||||||||||||||||
| 229 | |||||||||||||||||||||||||||||
| 230 | =cut | ||||||||||||||||||||||||||||
| 231 | |||||||||||||||||||||||||||||
| 232 | 101 | ▶ | sub start { | ||||||||||||||||||||||||||
|
Subroutine
start: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 233 | 101 | return shift->feature1->start(@_); | |||||||||||||||||||||||||||
| 234 | } | ||||||||||||||||||||||||||||
| 235 | |||||||||||||||||||||||||||||
| 236 | =head2 end | ||||||||||||||||||||||||||||
| 237 | |||||||||||||||||||||||||||||
| 238 | Title : end | ||||||||||||||||||||||||||||
| 239 | Usage : $end = $featpair->end | ||||||||||||||||||||||||||||
| 240 | $featpair->end($end) | ||||||||||||||||||||||||||||
| 241 | Function: get/set on the end coordinate of feature1 | ||||||||||||||||||||||||||||
| 242 | Returns : integer | ||||||||||||||||||||||||||||
| 243 | Args : [optional] ending point of feature | ||||||||||||||||||||||||||||
| 244 | |||||||||||||||||||||||||||||
| 245 | |||||||||||||||||||||||||||||
| 246 | =cut | ||||||||||||||||||||||||||||
| 247 | |||||||||||||||||||||||||||||
| 248 | 94 | ▶ | sub end { | ||||||||||||||||||||||||||
|
Subroutine
end: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 249 | 94 | return shift->feature1->end(@_); | |||||||||||||||||||||||||||
| 250 | } | ||||||||||||||||||||||||||||
| 251 | |||||||||||||||||||||||||||||
| 252 | =head2 strand | ||||||||||||||||||||||||||||
| 253 | |||||||||||||||||||||||||||||
| 254 | Title : strand | ||||||||||||||||||||||||||||
| 255 | Usage : $strand = $feat->strand() | ||||||||||||||||||||||||||||
| 256 | $feat->strand($strand) | ||||||||||||||||||||||||||||
| 257 | Function: get/set on strand information, being 1,-1 or 0 | ||||||||||||||||||||||||||||
| 258 | Returns : -1,1 or 0 | ||||||||||||||||||||||||||||
| 259 | Args : [optional] strand information to set | ||||||||||||||||||||||||||||
| 260 | |||||||||||||||||||||||||||||
| 261 | |||||||||||||||||||||||||||||
| 262 | =cut | ||||||||||||||||||||||||||||
| 263 | |||||||||||||||||||||||||||||
| 264 | 104 | ▶ | sub strand { | ||||||||||||||||||||||||||
|
Subroutine
strand: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 265 | 104 | return shift->feature1->strand(@_); | |||||||||||||||||||||||||||
| 266 | } | ||||||||||||||||||||||||||||
| 267 | |||||||||||||||||||||||||||||
| 268 | =head2 location | ||||||||||||||||||||||||||||
| 269 | |||||||||||||||||||||||||||||
| 270 | Title : location | ||||||||||||||||||||||||||||
| 271 | Usage : $location = $featpair->location | ||||||||||||||||||||||||||||
| 272 | $featpair->location($location) | ||||||||||||||||||||||||||||
| 273 | Function: Get/set location object (using feature1) | ||||||||||||||||||||||||||||
| 274 | Returns : Bio::LocationI object | ||||||||||||||||||||||||||||
| 275 | Args : [optional] LocationI to store | ||||||||||||||||||||||||||||
| 276 | |||||||||||||||||||||||||||||
| 277 | =cut | ||||||||||||||||||||||||||||
| 278 | |||||||||||||||||||||||||||||
| 279 | 0 | ▶ | sub location { | ||||||||||||||||||||||||||
|
Subroutine
location: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 280 | 0 | return shift->feature1->location(@_); | |||||||||||||||||||||||||||
| 281 | } | ||||||||||||||||||||||||||||
| 282 | |||||||||||||||||||||||||||||
| 283 | =head2 score | ||||||||||||||||||||||||||||
| 284 | |||||||||||||||||||||||||||||
| 285 | Title : score | ||||||||||||||||||||||||||||
| 286 | Usage : $score = $feat->score() | ||||||||||||||||||||||||||||
| 287 | $feat->score($score) | ||||||||||||||||||||||||||||
| 288 | Function: get/set on score information | ||||||||||||||||||||||||||||
| 289 | Returns : float | ||||||||||||||||||||||||||||
| 290 | Args : none if get, the new value if set | ||||||||||||||||||||||||||||
| 291 | |||||||||||||||||||||||||||||
| 292 | |||||||||||||||||||||||||||||
| 293 | =cut | ||||||||||||||||||||||||||||
| 294 | |||||||||||||||||||||||||||||
| 295 | 1 | ▶ | sub score { | ||||||||||||||||||||||||||
|
Subroutine
score: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 296 | 1 | return shift->feature1->score(@_); | |||||||||||||||||||||||||||
| 297 | } | ||||||||||||||||||||||||||||
| 298 | |||||||||||||||||||||||||||||
| 299 | =head2 frame | ||||||||||||||||||||||||||||
| 300 | |||||||||||||||||||||||||||||
| 301 | Title : frame | ||||||||||||||||||||||||||||
| 302 | Usage : $frame = $feat->frame() | ||||||||||||||||||||||||||||
| 303 | $feat->frame($frame) | ||||||||||||||||||||||||||||
| 304 | Function: get/set on frame information | ||||||||||||||||||||||||||||
| 305 | Returns : 0,1,2 | ||||||||||||||||||||||||||||
| 306 | Args : none if get, the new value if set | ||||||||||||||||||||||||||||
| 307 | |||||||||||||||||||||||||||||
| 308 | |||||||||||||||||||||||||||||
| 309 | =cut | ||||||||||||||||||||||||||||
| 310 | |||||||||||||||||||||||||||||
| 311 | 0 | ▶ | sub frame { | ||||||||||||||||||||||||||
|
Subroutine
frame: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 312 | 0 | return shift->feature1->frame(@_); | |||||||||||||||||||||||||||
| 313 | } | ||||||||||||||||||||||||||||
| 314 | |||||||||||||||||||||||||||||
| 315 | =head2 primary_tag | ||||||||||||||||||||||||||||
| 316 | |||||||||||||||||||||||||||||
| 317 | Title : primary_tag | ||||||||||||||||||||||||||||
| 318 | Usage : $ptag = $featpair->primary_tag | ||||||||||||||||||||||||||||
| 319 | Function: get/set on the primary_tag of feature1 | ||||||||||||||||||||||||||||
| 320 | Returns : 0,1,2 | ||||||||||||||||||||||||||||
| 321 | Args : none if get, the new value if set | ||||||||||||||||||||||||||||
| 322 | |||||||||||||||||||||||||||||
| 323 | |||||||||||||||||||||||||||||
| 324 | =cut | ||||||||||||||||||||||||||||
| 325 | |||||||||||||||||||||||||||||
| 326 | 1364 | ▶ | sub primary_tag { | ||||||||||||||||||||||||||
|
Subroutine
primary_tag: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 327 | 1364 | return shift->feature1->primary_tag(@_); | |||||||||||||||||||||||||||
| 328 | } | ||||||||||||||||||||||||||||
| 329 | |||||||||||||||||||||||||||||
| 330 | =head2 source_tag | ||||||||||||||||||||||||||||
| 331 | |||||||||||||||||||||||||||||
| 332 | Title : source_tag | ||||||||||||||||||||||||||||
| 333 | Usage : $tag = $feat->source_tag() | ||||||||||||||||||||||||||||
| 334 | $feat->source_tag('genscan'); | ||||||||||||||||||||||||||||
| 335 | Function: Returns the source tag for a feature, | ||||||||||||||||||||||||||||
| 336 | eg, 'genscan' | ||||||||||||||||||||||||||||
| 337 | Returns : a string | ||||||||||||||||||||||||||||
| 338 | Args : none | ||||||||||||||||||||||||||||
| 339 | |||||||||||||||||||||||||||||
| 340 | |||||||||||||||||||||||||||||
| 341 | =cut | ||||||||||||||||||||||||||||
| 342 | |||||||||||||||||||||||||||||
| 343 | 25 | ▶ | sub source_tag { | ||||||||||||||||||||||||||
|
Subroutine
source_tag: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 344 | 25 | return shift->feature1->source_tag(@_); | |||||||||||||||||||||||||||
| 345 | } | ||||||||||||||||||||||||||||
| 346 | |||||||||||||||||||||||||||||
| 347 | =head2 seqname | ||||||||||||||||||||||||||||
| 348 | |||||||||||||||||||||||||||||
| 349 | Title : seqname | ||||||||||||||||||||||||||||
| 350 | Usage : $obj->seq_id($newval) | ||||||||||||||||||||||||||||
| 351 | Function: There are many cases when you make a feature that you | ||||||||||||||||||||||||||||
| 352 | do know the sequence name, but do not know its actual | ||||||||||||||||||||||||||||
| 353 | sequence. This is an attribute such that you can store | ||||||||||||||||||||||||||||
| 354 | the seqname. | ||||||||||||||||||||||||||||
| 355 | |||||||||||||||||||||||||||||
| 356 | This attribute should *not* be used in GFF dumping, as | ||||||||||||||||||||||||||||
| 357 | that should come from the collection in which the seq | ||||||||||||||||||||||||||||
| 358 | feature was found. | ||||||||||||||||||||||||||||
| 359 | Returns : value of seqname | ||||||||||||||||||||||||||||
| 360 | Args : newvalue (optional) | ||||||||||||||||||||||||||||
| 361 | |||||||||||||||||||||||||||||
| 362 | |||||||||||||||||||||||||||||
| 363 | =cut | ||||||||||||||||||||||||||||
| 364 | |||||||||||||||||||||||||||||
| 365 | 31 | ▶ | sub seq_id { | ||||||||||||||||||||||||||
|
Subroutine
seq_id: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 366 | 31 | return shift->feature1->seq_id(@_); | |||||||||||||||||||||||||||
| 367 | } | ||||||||||||||||||||||||||||
| 368 | |||||||||||||||||||||||||||||
| 369 | =head2 hseqname | ||||||||||||||||||||||||||||
| 370 | |||||||||||||||||||||||||||||
| 371 | Title : hseqname | ||||||||||||||||||||||||||||
| 372 | Usage : $featpair->hseqname($newval) | ||||||||||||||||||||||||||||
| 373 | Function: Get/set method for the name of | ||||||||||||||||||||||||||||
| 374 | feature2. | ||||||||||||||||||||||||||||
| 375 | Returns : value of $feature2->seq_id | ||||||||||||||||||||||||||||
| 376 | Args : newvalue (optional) | ||||||||||||||||||||||||||||
| 377 | |||||||||||||||||||||||||||||
| 378 | |||||||||||||||||||||||||||||
| 379 | =cut | ||||||||||||||||||||||||||||
| 380 | |||||||||||||||||||||||||||||
| 381 | 0 | ▶ | sub hseq_id { | ||||||||||||||||||||||||||
|
Subroutine
hseq_id: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||
| 382 | 0 | return shift->feature2->seq_id(@_); | |||||||||||||||||||||||||||
| 383 | } | ||||||||||||||||||||||||||||
| 384 | |||||||||||||||||||||||||||||
| 385 | |||||||||||||||||||||||||||||
| 386 | =head2 hstart | ||||||||||||||||||||||||||||
| 387 | |||||||||||||||||||||||||||||
| 388 | Title : hstart | ||||||||||||||||||||||||||||
| 389 | Usage : $start = $featpair->hstart | ||||||||||||||||||||||||||||
| 390 | $featpair->hstart(20) | ||||||||||||||||||||||||||||
| 391 | Function: Get/set on the start coordinate of feature2 | ||||||||||||||||||||||||||||
| 392 | Returns : integer | ||||||||||||||||||||||||||||
| 393 | Args : none | ||||||||||||||||||||||||||||
| 394 | |||||||||||||||||||||||||||||
| 395 | =cut | ||||||||||||||||||||||||||||
| 396 | |||||||||||||||||||||||||||||
| 397 | 1 | ▶ | sub hstart { | ||||||||||||||||||||||||||
|
Subroutine
hstart: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 398 | 1 | return shift->feature2->start(@_); | |||||||||||||||||||||||||||
| 399 | } | ||||||||||||||||||||||||||||
| 400 | |||||||||||||||||||||||||||||
| 401 | =head2 hend | ||||||||||||||||||||||||||||
| 402 | |||||||||||||||||||||||||||||
| 403 | Title : hend | ||||||||||||||||||||||||||||
| 404 | Usage : $end = $featpair->hend | ||||||||||||||||||||||||||||
| 405 | $featpair->hend($end) | ||||||||||||||||||||||||||||
| 406 | Function: get/set on the end coordinate of feature2 | ||||||||||||||||||||||||||||
| 407 | Returns : integer | ||||||||||||||||||||||||||||
| 408 | Args : none | ||||||||||||||||||||||||||||
| 409 | |||||||||||||||||||||||||||||
| 410 | |||||||||||||||||||||||||||||
| 411 | =cut | ||||||||||||||||||||||||||||
| 412 | |||||||||||||||||||||||||||||
| 413 | 1 | ▶ | sub hend { | ||||||||||||||||||||||||||
|
Subroutine
hend: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 414 | 1 | return shift->feature2->end(@_); | |||||||||||||||||||||||||||
| 415 | } | ||||||||||||||||||||||||||||
| 416 | |||||||||||||||||||||||||||||
| 417 | |||||||||||||||||||||||||||||
| 418 | =head2 hstrand | ||||||||||||||||||||||||||||
| 419 | |||||||||||||||||||||||||||||
| 420 | Title : hstrand | ||||||||||||||||||||||||||||
| 421 | Usage : $strand = $feat->strand() | ||||||||||||||||||||||||||||
| 422 | $feat->strand($strand) | ||||||||||||||||||||||||||||
| 423 | Function: get/set on strand information, being 1,-1 or 0 | ||||||||||||||||||||||||||||
| 424 | Returns : -1,1 or 0 | ||||||||||||||||||||||||||||
| 425 | Args : none | ||||||||||||||||||||||||||||
| 426 | |||||||||||||||||||||||||||||
| 427 | |||||||||||||||||||||||||||||
| 428 | =cut | ||||||||||||||||||||||||||||
| 429 | |||||||||||||||||||||||||||||
| 430 | 0 | ▶ | sub hstrand { | ||||||||||||||||||||||||||
|
Subroutine
hstrand: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 431 | 0 | return shift->feature2->strand(@_); | |||||||||||||||||||||||||||
| 432 | } | ||||||||||||||||||||||||||||
| 433 | |||||||||||||||||||||||||||||
| 434 | =head2 hscore | ||||||||||||||||||||||||||||
| 435 | |||||||||||||||||||||||||||||
| 436 | Title : hscore | ||||||||||||||||||||||||||||
| 437 | Usage : $score = $feat->score() | ||||||||||||||||||||||||||||
| 438 | $feat->score($score) | ||||||||||||||||||||||||||||
| 439 | Function: get/set on score information | ||||||||||||||||||||||||||||
| 440 | Returns : float | ||||||||||||||||||||||||||||
| 441 | Args : none if get, the new value if set | ||||||||||||||||||||||||||||
| 442 | |||||||||||||||||||||||||||||
| 443 | |||||||||||||||||||||||||||||
| 444 | =cut | ||||||||||||||||||||||||||||
| 445 | |||||||||||||||||||||||||||||
| 446 | 0 | ▶ | sub hscore { | ||||||||||||||||||||||||||
|
Subroutine
hscore: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 447 | 0 | return shift->feature2->score(@_); | |||||||||||||||||||||||||||
| 448 | } | ||||||||||||||||||||||||||||
| 449 | |||||||||||||||||||||||||||||
| 450 | =head2 hframe | ||||||||||||||||||||||||||||
| 451 | |||||||||||||||||||||||||||||
| 452 | Title : hframe | ||||||||||||||||||||||||||||
| 453 | Usage : $frame = $feat->frame() | ||||||||||||||||||||||||||||
| 454 | $feat->frame($frame) | ||||||||||||||||||||||||||||
| 455 | Function: get/set on frame information | ||||||||||||||||||||||||||||
| 456 | Returns : 0,1,2 | ||||||||||||||||||||||||||||
| 457 | Args : none if get, the new value if set | ||||||||||||||||||||||||||||
| 458 | |||||||||||||||||||||||||||||
| 459 | |||||||||||||||||||||||||||||
| 460 | =cut | ||||||||||||||||||||||||||||
| 461 | |||||||||||||||||||||||||||||
| 462 | 0 | ▶ | sub hframe { | ||||||||||||||||||||||||||
|
Subroutine
hframe: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 463 | 0 | return shift->feature2->frame(@_); | |||||||||||||||||||||||||||
| 464 | } | ||||||||||||||||||||||||||||
| 465 | |||||||||||||||||||||||||||||
| 466 | =head2 hprimary_tag | ||||||||||||||||||||||||||||
| 467 | |||||||||||||||||||||||||||||
| 468 | Title : hprimary_tag | ||||||||||||||||||||||||||||
| 469 | Usage : $ptag = $featpair->hprimary_tag | ||||||||||||||||||||||||||||
| 470 | Function: Get/set on the primary_tag of feature2 | ||||||||||||||||||||||||||||
| 471 | Returns : 0,1,2 | ||||||||||||||||||||||||||||
| 472 | Args : none if get, the new value if set | ||||||||||||||||||||||||||||
| 473 | |||||||||||||||||||||||||||||
| 474 | |||||||||||||||||||||||||||||
| 475 | =cut | ||||||||||||||||||||||||||||
| 476 | |||||||||||||||||||||||||||||
| 477 | 1 | ▶ | sub hprimary_tag { | ||||||||||||||||||||||||||
|
Subroutine
hprimary_tag: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 478 | 1 | return shift->feature2->primary_tag(@_); | |||||||||||||||||||||||||||
| 479 | } | ||||||||||||||||||||||||||||
| 480 | |||||||||||||||||||||||||||||
| 481 | =head2 hsource_tag | ||||||||||||||||||||||||||||
| 482 | |||||||||||||||||||||||||||||
| 483 | Title : hsource_tag | ||||||||||||||||||||||||||||
| 484 | Usage : $tag = $feat->hsource_tag() | ||||||||||||||||||||||||||||
| 485 | $feat->source_tag('genscan'); | ||||||||||||||||||||||||||||
| 486 | Function: Returns the source tag for a feature, | ||||||||||||||||||||||||||||
| 487 | eg, 'genscan' | ||||||||||||||||||||||||||||
| 488 | Returns : a string | ||||||||||||||||||||||||||||
| 489 | Args : none | ||||||||||||||||||||||||||||
| 490 | |||||||||||||||||||||||||||||
| 491 | |||||||||||||||||||||||||||||
| 492 | =cut | ||||||||||||||||||||||||||||
| 493 | |||||||||||||||||||||||||||||
| 494 | 1 | ▶ | sub hsource_tag { | ||||||||||||||||||||||||||
|
Subroutine
hsource_tag: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 495 | 1 | return shift->feature2->source_tag(@_); | |||||||||||||||||||||||||||
| 496 | } | ||||||||||||||||||||||||||||
| 497 | |||||||||||||||||||||||||||||
| 498 | =head2 invert | ||||||||||||||||||||||||||||
| 499 | |||||||||||||||||||||||||||||
| 500 | Title : invert | ||||||||||||||||||||||||||||
| 501 | Usage : $tag = $feat->invert | ||||||||||||||||||||||||||||
| 502 | Function: Swaps feature1 and feature2 around | ||||||||||||||||||||||||||||
| 503 | Returns : Nothing | ||||||||||||||||||||||||||||
| 504 | Args : none | ||||||||||||||||||||||||||||
| 505 | |||||||||||||||||||||||||||||
| 506 | |||||||||||||||||||||||||||||
| 507 | =cut | ||||||||||||||||||||||||||||
| 508 | |||||||||||||||||||||||||||||
| 509 | 1 | ▶ | sub invert { | ||||||||||||||||||||||||||
|
Subroutine
invert: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 510 | 1 | my ($self) = @_; | |||||||||||||||||||||||||||
| 511 | |||||||||||||||||||||||||||||
| 512 | 1 | my $tmp = $self->feature1; | |||||||||||||||||||||||||||
| 513 | |||||||||||||||||||||||||||||
| 514 | 1 | $self->feature1($self->feature2); | |||||||||||||||||||||||||||
| 515 | 1 | $self->feature2($tmp); | |||||||||||||||||||||||||||
| 516 | 1 | return 1; | |||||||||||||||||||||||||||
| 517 | } | ||||||||||||||||||||||||||||
| 518 | |||||||||||||||||||||||||||||
| 519 | =head2 feature_factory | ||||||||||||||||||||||||||||
| 520 | |||||||||||||||||||||||||||||
| 521 | Title : feature_factory | ||||||||||||||||||||||||||||
| 522 | Usage : $obj->feature_factory($newval) | ||||||||||||||||||||||||||||
| 523 | Function: Get/set the feature object factory for this feature pair. | ||||||||||||||||||||||||||||
| 524 | |||||||||||||||||||||||||||||
| 525 | The feature object factory will be used to create a feature | ||||||||||||||||||||||||||||
| 526 | object if feature1() or feature2() is called in get mode | ||||||||||||||||||||||||||||
| 527 | without having been set before. | ||||||||||||||||||||||||||||
| 528 | |||||||||||||||||||||||||||||
| 529 | The default is an instance of Bio::Factory::ObjectFactory | ||||||||||||||||||||||||||||
| 530 | and hence allows the type to be changed dynamically at any | ||||||||||||||||||||||||||||
| 531 | time. | ||||||||||||||||||||||||||||
| 532 | |||||||||||||||||||||||||||||
| 533 | Example : | ||||||||||||||||||||||||||||
| 534 | Returns : The feature object factory in use (a | ||||||||||||||||||||||||||||
| 535 | Bio::Factory::ObjectFactoryI compliant object) | ||||||||||||||||||||||||||||
| 536 | Args : on set, a Bio::Factory::ObjectFactoryI compliant object | ||||||||||||||||||||||||||||
| 537 | |||||||||||||||||||||||||||||
| 538 | |||||||||||||||||||||||||||||
| 539 | =cut | ||||||||||||||||||||||||||||
| 540 | |||||||||||||||||||||||||||||
| 541 | 3651 | ▶ | sub feature_factory { | ||||||||||||||||||||||||||
|
Subroutine
feature_factory: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 542 | 3651 | my $self = shift; | |||||||||||||||||||||||||||
| 543 | |||||||||||||||||||||||||||||
| 544 | 3651 | ▶ | return $self->{'feature_factory'} = shift if @_; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 545 | 2265 | return $self->{'feature_factory'}; | |||||||||||||||||||||||||||
| 546 | } | ||||||||||||||||||||||||||||
| 547 | |||||||||||||||||||||||||||||
| 548 | ################################################################# | ||||||||||||||||||||||||||||
| 549 | # aliases for backwards compatibility # | ||||||||||||||||||||||||||||
| 550 | ################################################################# | ||||||||||||||||||||||||||||
| 551 | |||||||||||||||||||||||||||||
| 552 | # seqname() is already aliased in Generic.pm, and we overwrite seq_id | ||||||||||||||||||||||||||||
| 553 | |||||||||||||||||||||||||||||
| 554 | 0 | ▶ | sub hseqname { | ||||||||||||||||||||||||||
|
Subroutine
hseqname: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 555 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 556 | 0 | $self->warn("SeqFeatureI::seqname() is deprecated. Please use seq_id() instead."); | |||||||||||||||||||||||||||
| 557 | 0 | return $self->hseq_id(@_); | |||||||||||||||||||||||||||
| 558 | } | ||||||||||||||||||||||||||||
| 559 | |||||||||||||||||||||||||||||
| 560 | 1386 | ▶ | sub cleanup_fp { | ||||||||||||||||||||||||||
|
Subroutine
cleanup_fp: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 561 | 1386 | my $self = shift; | |||||||||||||||||||||||||||
| 562 | 1386 | $self->{'feature1'} = $self->{'feature2'} = undef; | |||||||||||||||||||||||||||
| 563 | } | ||||||||||||||||||||||||||||
| 564 | 77 | 1; | |||||||||||||||||||||||||||