| 1 | # | ||||||||||||||||||||||||||||
| 2 | # BioPerl module for Bio::SeqFeature::SubSeq | ||||||||||||||||||||||||||||
| 3 | # | ||||||||||||||||||||||||||||
| 4 | # Please direct questions and support issues to <bioperl-l@bioperl.org> | ||||||||||||||||||||||||||||
| 5 | # | ||||||||||||||||||||||||||||
| 6 | # Copyright Florent Angly | ||||||||||||||||||||||||||||
| 7 | # | ||||||||||||||||||||||||||||
| 8 | # You may distribute this module under the same terms as perl itself | ||||||||||||||||||||||||||||
| 9 | |||||||||||||||||||||||||||||
| 10 | |||||||||||||||||||||||||||||
| 11 | =head1 NAME | ||||||||||||||||||||||||||||
| 12 | |||||||||||||||||||||||||||||
| 13 | Bio::SeqFeature::SubSeq - Feature representing a subsequence | ||||||||||||||||||||||||||||
| 14 | |||||||||||||||||||||||||||||
| 15 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||
| 16 | |||||||||||||||||||||||||||||
| 17 | # SubSeq with implicit sequence | ||||||||||||||||||||||||||||
| 18 | use Bio::Seq; | ||||||||||||||||||||||||||||
| 19 | my $template = Bio::Seq->new( -seq => 'AAAAACCCCCGGGGGTTTTT' ); | ||||||||||||||||||||||||||||
| 20 | $subseq = Bio::SeqFeature::Amplicon->new( | ||||||||||||||||||||||||||||
| 21 | -start => 6, | ||||||||||||||||||||||||||||
| 22 | -end => 15, | ||||||||||||||||||||||||||||
| 23 | -template => $template, | ||||||||||||||||||||||||||||
| 24 | ); | ||||||||||||||||||||||||||||
| 25 | print "Subsequence is: ".$amplicon->seq->seq."\n"; # Should be 'CCCCCGGGGG' | ||||||||||||||||||||||||||||
| 26 | |||||||||||||||||||||||||||||
| 27 | # SubSeq with explicit sequence | ||||||||||||||||||||||||||||
| 28 | use Bio::SeqFeature::Subseq; | ||||||||||||||||||||||||||||
| 29 | my $subseq = Bio::SeqFeature::Amplicon->new( | ||||||||||||||||||||||||||||
| 30 | -seq => $seq_object, | ||||||||||||||||||||||||||||
| 31 | ); | ||||||||||||||||||||||||||||
| 32 | |||||||||||||||||||||||||||||
| 33 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 34 | |||||||||||||||||||||||||||||
| 35 | Bio::SeqFeature::SubSeq extends L<Bio::SeqFeature::Generic> features to | ||||||||||||||||||||||||||||
| 36 | represent a subsequence. When this feature is attached to a template sequence, | ||||||||||||||||||||||||||||
| 37 | the sequence of feature is the subsequence of the template at this location. The | ||||||||||||||||||||||||||||
| 38 | purpose of this class is to represent a sequence as a feature without having to | ||||||||||||||||||||||||||||
| 39 | explicitly store its sequence string. | ||||||||||||||||||||||||||||
| 40 | |||||||||||||||||||||||||||||
| 41 | Of course, you might have reasons to explicitly set a sequence. In that case, | ||||||||||||||||||||||||||||
| 42 | note that the length of the sequence is allowed to not match the position of the | ||||||||||||||||||||||||||||
| 43 | feature. For example, you can set sequence of length 10 in a SubSeq feature that | ||||||||||||||||||||||||||||
| 44 | spans positions 30 to 50 of the template if you so desire. | ||||||||||||||||||||||||||||
| 45 | |||||||||||||||||||||||||||||
| 46 | =head1 FEEDBACK | ||||||||||||||||||||||||||||
| 47 | |||||||||||||||||||||||||||||
| 48 | =head2 Mailing Lists | ||||||||||||||||||||||||||||
| 49 | |||||||||||||||||||||||||||||
| 50 | User feedback is an integral part of the evolution of this and other | ||||||||||||||||||||||||||||
| 51 | Bioperl modules. Send your comments and suggestions preferably to one | ||||||||||||||||||||||||||||
| 52 | of the Bioperl mailing lists. Your participation is much appreciated. | ||||||||||||||||||||||||||||
| 53 | |||||||||||||||||||||||||||||
| 54 | bioperl-l@bioperl.org - General discussion | ||||||||||||||||||||||||||||
| 55 | http://bioperl.org/wiki/Mailing_lists - About the mailing lists | ||||||||||||||||||||||||||||
| 56 | |||||||||||||||||||||||||||||
| 57 | =head2 Support | ||||||||||||||||||||||||||||
| 58 | |||||||||||||||||||||||||||||
| 59 | Please direct usage questions or support issues to the mailing list: | ||||||||||||||||||||||||||||
| 60 | |||||||||||||||||||||||||||||
| 61 | I<bioperl-l@bioperl.org> | ||||||||||||||||||||||||||||
| 62 | |||||||||||||||||||||||||||||
| 63 | rather than to the module maintainer directly. Many experienced and | ||||||||||||||||||||||||||||
| 64 | reponsive experts will be able look at the problem and quickly | ||||||||||||||||||||||||||||
| 65 | address it. Please include a thorough description of the problem | ||||||||||||||||||||||||||||
| 66 | with code and data examples if at all possible. | ||||||||||||||||||||||||||||
| 67 | |||||||||||||||||||||||||||||
| 68 | =head2 Reporting Bugs | ||||||||||||||||||||||||||||
| 69 | |||||||||||||||||||||||||||||
| 70 | Report bugs to the Bioperl bug tracking system to help us keep track | ||||||||||||||||||||||||||||
| 71 | the bugs and their resolution. Bug reports can be submitted via | ||||||||||||||||||||||||||||
| 72 | the web: | ||||||||||||||||||||||||||||
| 73 | |||||||||||||||||||||||||||||
| 74 | https://github.com/bioperl/bioperl-live/issues | ||||||||||||||||||||||||||||
| 75 | |||||||||||||||||||||||||||||
| 76 | =head1 AUTHOR | ||||||||||||||||||||||||||||
| 77 | |||||||||||||||||||||||||||||
| 78 | Florent Angly <florent.angly@gmail.com> | ||||||||||||||||||||||||||||
| 79 | |||||||||||||||||||||||||||||
| 80 | =head1 APPENDIX | ||||||||||||||||||||||||||||
| 81 | |||||||||||||||||||||||||||||
| 82 | The rest of the documentation details each of the object | ||||||||||||||||||||||||||||
| 83 | methods. Internal methods are usually preceded with a _ | ||||||||||||||||||||||||||||
| 84 | |||||||||||||||||||||||||||||
| 85 | =cut | ||||||||||||||||||||||||||||
| 86 | |||||||||||||||||||||||||||||
| 87 | |||||||||||||||||||||||||||||
| 88 | package Bio::SeqFeature::SubSeq; | ||||||||||||||||||||||||||||
| 89 | 12 | $Bio::SeqFeature::SubSeq::VERSION = '1.7.8'; | |||||||||||||||||||||||||||
| 90 | 12 | ▶ | use strict; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 91 | |||||||||||||||||||||||||||||
| 92 | 12 | ▶ | use base qw(Bio::SeqFeature::Generic); | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 93 | |||||||||||||||||||||||||||||
| 94 | =head2 new | ||||||||||||||||||||||||||||
| 95 | |||||||||||||||||||||||||||||
| 96 | Title : new() | ||||||||||||||||||||||||||||
| 97 | Usage : my $subseq = Bio::SeqFeature::SubSeq( -start => 1, -end => 10, -strand => -1); | ||||||||||||||||||||||||||||
| 98 | Function: Instantiate a new Bio::SeqFeature::SubSeq feature object | ||||||||||||||||||||||||||||
| 99 | Args : -seq , the sequence object or sequence string of the feature (optional) | ||||||||||||||||||||||||||||
| 100 | -template , attach the feature to the provided parent template sequence or feature (optional). | ||||||||||||||||||||||||||||
| 101 | Note that you must specify the feature location to do this. | ||||||||||||||||||||||||||||
| 102 | -start, -end, -location, -strand and all other L<Bio::SeqFeature::Generic> argument can be used. | ||||||||||||||||||||||||||||
| 103 | Returns : A Bio::SeqFeature::SubSeq object | ||||||||||||||||||||||||||||
| 104 | |||||||||||||||||||||||||||||
| 105 | =cut | ||||||||||||||||||||||||||||
| 106 | |||||||||||||||||||||||||||||
| 107 | 73 | ▶ | sub new { | ||||||||||||||||||||||||||
|
Subroutine
new: called CC=9 SCAR=22.8
Pod
documented
| |||||||||||||||||||||||||||||
| 108 | 73 | my ($class, @args) = @_; | |||||||||||||||||||||||||||
| 109 | 73 | my $self = $class->SUPER::new(@args); | |||||||||||||||||||||||||||
| 110 | 73 | my ($seq, $template) = $self->_rearrange([qw(SEQ TEMPLATE)], @args); | |||||||||||||||||||||||||||
| 111 | 73 | ▶ | if (defined $seq) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 112 | # Set the subsequence explicitly | ||||||||||||||||||||||||||||
| 113 | 42 | ▶ | if (not ref $seq) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 114 | # Convert string to sequence object | ||||||||||||||||||||||||||||
| 115 | 35 | $seq = Bio::PrimarySeq->new( -seq => $seq ); | |||||||||||||||||||||||||||
| 116 | } else { | ||||||||||||||||||||||||||||
| 117 | # Sanity check | ||||||||||||||||||||||||||||
| 118 | 7 | ▶ | if (not $seq->isa('Bio::PrimarySeqI')) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 119 | 0 | $self->throw("Expected a sequence object but got a '".ref($seq)."'\n"); | |||||||||||||||||||||||||||
| 120 | } | ||||||||||||||||||||||||||||
| 121 | } | ||||||||||||||||||||||||||||
| 122 | 42 | $self->seq($seq); | |||||||||||||||||||||||||||
| 123 | } | ||||||||||||||||||||||||||||
| 124 | 73 | ▶ | if ($template) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 125 | 25 | ▶ | if ( not($self->start) || not($self->end) ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
$self->start and $self->end
MC/DC0%0/2
$self->start and $self->end
$self->start
$self->end
Truth table33%1/3
A and B
A= $self->startB= $self->end
| |||||||||||||||||||||||||||||
| 126 | 0 | $self->throw('Could not attach feature to template $template because'. | |||||||||||||||||||||||||||
| 127 | ' the feature location was not specified.'); | ||||||||||||||||||||||||||||
| 128 | } | ||||||||||||||||||||||||||||
| 129 | |||||||||||||||||||||||||||||
| 130 | # Need to attach to parent sequence and then add sequence feature | ||||||||||||||||||||||||||||
| 131 | 25 | my $template_seq; | |||||||||||||||||||||||||||
| 132 | 25 | ▶ | if ($template->isa('Bio::SeqFeature::Generic')) { | ||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||
| 133 | 2 | $template_seq = $template->entire_seq; | |||||||||||||||||||||||||||
| 134 | } elsif ($template->isa('Bio::SeqI')) { | ||||||||||||||||||||||||||||
| 135 | 23 | $template_seq = $template; | |||||||||||||||||||||||||||
| 136 | } else { | ||||||||||||||||||||||||||||
| 137 | 0 | $self->throw("Expected a Bio::SeqFeature::Generic or Bio::SeqI object". | |||||||||||||||||||||||||||
| 138 | " as template, but got '$template'."); | ||||||||||||||||||||||||||||
| 139 | } | ||||||||||||||||||||||||||||
| 140 | 25 | $self->attach_seq($template_seq); | |||||||||||||||||||||||||||
| 141 | 25 | $template->add_SeqFeature($self); | |||||||||||||||||||||||||||
| 142 | |||||||||||||||||||||||||||||
| 143 | } | ||||||||||||||||||||||||||||
| 144 | 73 | return $self; | |||||||||||||||||||||||||||
| 145 | } | ||||||||||||||||||||||||||||
| 146 | |||||||||||||||||||||||||||||
| 147 | |||||||||||||||||||||||||||||
| 148 | =head2 seq | ||||||||||||||||||||||||||||
| 149 | |||||||||||||||||||||||||||||
| 150 | Title : seq() | ||||||||||||||||||||||||||||
| 151 | Usage : my $seq = $subseq->seq(); | ||||||||||||||||||||||||||||
| 152 | Function: Get or set the sequence object of this SubSeq feature. If no sequence | ||||||||||||||||||||||||||||
| 153 | was provided, but the subseq is attached to a sequence, get the | ||||||||||||||||||||||||||||
| 154 | corresponding subsequence. | ||||||||||||||||||||||||||||
| 155 | Returns : A sequence object or undef | ||||||||||||||||||||||||||||
| 156 | Args : None. | ||||||||||||||||||||||||||||
| 157 | |||||||||||||||||||||||||||||
| 158 | =cut | ||||||||||||||||||||||||||||
| 159 | |||||||||||||||||||||||||||||
| 160 | 185 | ▶ | sub seq { | ||||||||||||||||||||||||||
|
Subroutine
seq: called CC=5 SCAR=16.6
Pod
documented
| |||||||||||||||||||||||||||||
| 161 | 185 | my ($self, $value) = @_; | |||||||||||||||||||||||||||
| 162 | 185 | ▶ | if (defined $value) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 163 | # The sequence is explicit | ||||||||||||||||||||||||||||
| 164 | 42 | ▶ | if ( not(ref $value) || not $value->isa('Bio::PrimarySeqI') ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
ref $value and $value->isa("Bio::PrimarySeqI")
MC/DC0%0/2
ref $value and $value->isa("Bio::PrimarySeqI")
ref $value
$value->isa("Bio::PrimarySeqI")
Truth table33%1/3
A and B
A= ref $valueB= $value->isa("Bio::PrimarySeqI")
| |||||||||||||||||||||||||||||
| 165 | 0 | $self->throw("Expected a sequence object but got a '".ref($value)."'\n"); | |||||||||||||||||||||||||||
| 166 | } | ||||||||||||||||||||||||||||
| 167 | 42 | $self->{seq} = $value; | |||||||||||||||||||||||||||
| 168 | } | ||||||||||||||||||||||||||||
| 169 | 185 | my $seq = $self->{seq}; | |||||||||||||||||||||||||||
| 170 | 185 | ▶ | if (not defined $seq) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 171 | # The sequence is implied | ||||||||||||||||||||||||||||
| 172 | 27 | $seq = $self->SUPER::seq; | |||||||||||||||||||||||||||
| 173 | } | ||||||||||||||||||||||||||||
| 174 | 185 | return $seq; | |||||||||||||||||||||||||||
| 175 | } | ||||||||||||||||||||||||||||
| 176 | |||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||
| 178 | =head2 length | ||||||||||||||||||||||||||||
| 179 | |||||||||||||||||||||||||||||
| 180 | Title : seq() | ||||||||||||||||||||||||||||
| 181 | Usage : my $length = $subseq->seq(); | ||||||||||||||||||||||||||||
| 182 | Function: Get the length of the SubSeq feature. It is similar to the length() | ||||||||||||||||||||||||||||
| 183 | method of L<Bio::Generic::SeqFeature>, which computes length based | ||||||||||||||||||||||||||||
| 184 | on the location of the feature. However, if the feature was not | ||||||||||||||||||||||||||||
| 185 | given a location, return the length of the subsequence if possible. | ||||||||||||||||||||||||||||
| 186 | Returns : integer or undef | ||||||||||||||||||||||||||||
| 187 | Args : None. | ||||||||||||||||||||||||||||
| 188 | |||||||||||||||||||||||||||||
| 189 | =cut | ||||||||||||||||||||||||||||
| 190 | |||||||||||||||||||||||||||||
| 191 | 7 | ▶ | sub length { | ||||||||||||||||||||||||||
|
Subroutine
length: called CC=4 SCAR=13.9
Pod
documented
| |||||||||||||||||||||||||||||
| 192 | 7 | my ($self) = @_; | |||||||||||||||||||||||||||
| 193 | # Try length from location first | ||||||||||||||||||||||||||||
| 194 | 7 | ▶ | if ($self->start && $self->end) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
$self->start and $self->end
MC/DC50%1/2
$self->start and $self->end
$self->start
$self->end
Truth table66%2/3
A and B
A= $self->startB= $self->end
| |||||||||||||||||||||||||||||
| 195 | 4 | return $self->SUPER::length(); | |||||||||||||||||||||||||||
| 196 | } | ||||||||||||||||||||||||||||
| 197 | # Then try length from subsequence | ||||||||||||||||||||||||||||
| 198 | 3 | my $seq = $self->seq; | |||||||||||||||||||||||||||
| 199 | 3 | ▶ | if (defined $seq) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 200 | 2 | return length $seq->seq; | |||||||||||||||||||||||||||
| 201 | } | ||||||||||||||||||||||||||||
| 202 | # We failed | ||||||||||||||||||||||||||||
| 203 | 1 | return undef; | |||||||||||||||||||||||||||
| 204 | } | ||||||||||||||||||||||||||||
| 205 | |||||||||||||||||||||||||||||
| 206 | |||||||||||||||||||||||||||||
| 207 | |||||||||||||||||||||||||||||
| 208 | 12 | 1; | |||||||||||||||||||||||||||