Bio/Seq/Meta.pm

filter: Statementstmt 81.1% 103 / 127 Branchbran 60.8% 45 / 74 Conditioncond 34.1% 14 / 41 MC/DCmcdc 4.0% 1 / 25 Subroutinesub 73.9% 17 / 23 Podpod 94.1% 16 / 17 totaltotal 63.8% 196 / 307 CC 56 SCAR 24.3
CC
56
Cov
67%
_test_gap_positions
42.0
is_flush
19.1
named_submeta
14.7
CRAP 11.3
« Bio/Tools/Spidey/Results.pm ↑ Summary Bio/SeqIO/bsml_sax.pm »
1 #
2 # BioPerl module for Bio::Seq::Meta
3 #
4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
5 #
6 # Cared for by Heikki Lehvaslaiho
7 #
8 # Copyright Heikki Lehvaslaiho
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::Seq::Meta - Generic superclass for sequence objects with
17 residue-based meta information
18  
19 =head1 SYNOPSIS
20  
21 use Bio::LocatableSeq;
22 use Bio::Seq::Meta;
23 use Bio::Tools::OddCodes;
24 use Bio::SeqIO;
25  
26 my $seq = Bio::Seq::Meta->new(-id=>'test',
27 -seq=>'ACTGCTAGCT',
28 -start=>2434,
29 -end=>2443,
30 -strand=>1,
31 -verbose=>1, # to see warnings
32 );
33  
34 # the existing sequence object can be a Bio::PrimarySeq, too
35  
36 # to test this is a meta seq object
37 $seq->isa("Bio::Seq::Meta")
38 || $seq->throw("$seq is not a Bio::Seq::Meta");
39  
40  
41 $seq->meta('1234567890');
42 $seq = Bio::Seq::Meta->new(-id=>'test',
43 -seq=>'HACILMIFGT',
44 -start=>2434,
45 -end=>2443,
46 -strand=>1,
47 -meta=>'1234567890',
48 -verbose=>1, # to see warnings
49 );
50  
51 # accessors
52 $string = $seq->meta_text();
53 $substring = $seq->submeta_text(2,5);
54 $unique_key = $seq->accession_number();
55  
56 # storing output from Bio::Tools::OddCodes as meta data
57 my $protcodes = Bio::Tools::OddCodes->new(-seq => $seq);
58 my @codes = qw(structural chemical functional charge hydrophobic);
59 map { $seq->named_meta($_, ${$protcodes->$_($seq) } )} @codes;
60  
61 my $out = Bio::SeqIO->new(-format=>'metafasta');
62 $out->write_seq($seq);
63  
64 =head1 DESCRIPTION
65  
66 This class implements generic methods for sequences with residue-based
67 meta information. Meta sequences with meta data are Bio::LocatableSeq
68 objects with additional methods to store that meta information. See
69 L<Bio::LocatableSeq> and L<Bio::Seq::MetaI>.
70  
71 The meta information in this class is always one character per residue
72 long and blank values are space characters (ASCII 32).
73  
74 After the latest rewrite, the meta information no longer covers all
75 the residues automatically. Methods to check the length of meta
76 information (L<meta_length>)and to see if the ends are flushed to the
77 sequence have been added (L<is_flush>). To force the old
78 functionality, set L<force_flush> to true.
79  
80 It is assumed that meta data values do not depend on the nucleotide
81 sequence strand value.
82  
83 Application specific implementations should inherit from this class to
84 override and add to these methods.
85  
86 L<Bio::Seq::Meta::Array> allows for more complex meta values (scalars
87 or objects) to be used.
88  
89 =head2 Method naming
90  
91 Character based meta data is read and set by method meta() and its
92 variants. These are the suffixes and prefixes used in the variants:
93  
94 [named_] [sub] meta [_text]
95  
96 =over 3
97  
98 =item _text
99  
100 Suffix B<_text> guaranties that output is a string. Note that it does
101 not limit the input.
102  
103 In this implementation, the output is always text, so these methods
104 are redundant.
105  
106 =item sub
107  
108 Prefix B<sub>, like in subseq(), means that the method applies to sub
109 region of the sequence range and takes start and end as arguments.
110 Unlike subseq(), these methods are able to set values. If the range
111 is not defined, it defaults to the complete sequence.
112  
113 =item named
114  
115 Prefix B<named_> in method names allows the used to attach multiple
116 meta strings to one sequence by explicitly naming them. The name is
117 always the first argument to the method. The "unnamed" methods use the
118 class wide default name for the meta data and are thus special cases
119 "named" methods.
120  
121 Note that internally names are keys in a hash and any misspelling of a
122 name will silently store the data under a wrong name. The used names
123 (keys) can be retrieved using method meta_names(). See L<meta_names>.
124  
125 =back
126  
127 =head1 NOTE
128  
129 This Bio::Seq::MetaI implementation inherits from Bio::LocatableSeq, which
130 itself inherits from Bio::PrimarySeq. It is not a Bio::SeqI, so bless-ing
131 objects of this class into a Bio::SeqI or vice versa and will not work as
132 expected (see bug 2262). This may be addressed in a future refactor of
133 Bio::LocatableSeq.
134  
135  
136 =head1 SEE ALSO
137  
138 L<Bio::LocatableSeq>,
139 L<Bio::Seq::MetaI>,
140 L<Bio::Seq::Meta::Array>
141  
142 =head1 FEEDBACK
143  
144 =head2 Mailing Lists
145  
146 User feedback is an integral part of the evolution of this and other
147 Bioperl modules. Send your comments and suggestions preferably to one
148 of the Bioperl mailing lists. Your participation is much appreciated.
149  
150 bioperl-l@bioperl.org - General discussion
151 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
152  
153 =head2 Support
154  
155 Please direct usage questions or support issues to the mailing list:
156  
157 I<bioperl-l@bioperl.org>
158  
159 rather than to the module maintainer directly. Many experienced and
160 reponsive experts will be able look at the problem and quickly
161 address it. Please include a thorough description of the problem
162 with code and data examples if at all possible.
163  
164 =head2 Reporting Bugs
165  
166 Report bugs to the Bioperl bug tracking system to help us keep track
167 the bugs and their resolution. Bug reports can be submitted via the
168 web:
169  
170 https://github.com/bioperl/bioperl-live/issues
171  
172 =head1 AUTHOR - Heikki Lehvaslaiho
173  
174 Email heikki-at-bioperl-dot-org
175  
176 =head1 CONTRIBUTORS
177  
178 Chad Matsalla, bioinformatics@dieselwurks.com
179  
180 Aaron Mackey, amackey@virginia.edu
181  
182 =head1 APPENDIX
183  
184 The rest of the documentation details each of the object methods.
185 Internal methods are usually preceded with a _
186  
187 =cut
188  
189  
190 # Let the code begin...
191  
192  
193 package Bio::Seq::Meta;
194 11 $Bio::Seq::Meta::VERSION = '1.7.8';
195 11 ▶use vars qw($DEFAULT_NAME $GAP $META_GAP);
Subroutine BEGIN: called CC=1 SCAR=0.0
196 11 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
197  
198 #use overload '""' => \&to_string;
199  
200 11 ▶use base qw(Bio::LocatableSeq Bio::Seq::MetaI);
Subroutine BEGIN: called CC=1 SCAR=0.0
201  
202  
203 11 ▶BEGIN {
Subroutine BEGIN: called CC=1 SCAR=0.0
204  
205 11 $DEFAULT_NAME = 'DEFAULT';
206 11 $GAP = '-';
207 11 $META_GAP = ' ';
208 }
209  
210 =head2 new
211  
212 Title : new
213 Usage : $metaseq = Bio::Seq::Meta->new
214 ( -meta => 'aaaaaaaabbbbbbbb',
215 -seq => 'TKLMILVSHIVILSRM'
216 -id => 'human_id',
217 -accession_number => 'S000012',
218 );
219 Function: Constructor for Bio::Seq::Meta class, meta data being in a
220 string. Note that you can provide an empty quality string.
221 Returns : a new Bio::Seq::Meta object
222  
223 =cut
224  
225  
226 21 ▶sub new {
Subroutine new: called CC=6 SCAR=20.8
Pod documented
227 21 my ($class, @args) = @_;
228  
229 21 my $self = $class->SUPER::new(@args);
230  
231 21 my($meta, $forceflush, $nm) =
232 $self->_rearrange([qw(META
233 FORCE_FLUSH
234 NAMED_META)],
235 @args);
236  
237 #$self->{'_meta'} = {};
238 21 $self->{'_meta'}->{$DEFAULT_NAME} = "";
239  
240 21 ▶ $meta && $self->meta($meta);
Branch: 1 branch
BranchTrueFalseTotal
$meta and $self->meta($meta) 0 21 21
241 21 ▶ if ($nm && ref($nm) eq 'HASH') {
Branch: 1 branch
BranchTrueFalseTotal
if ($nm and ref $nm eq "HASH") 0 21 21
Condition33%1/3
$nm and ref $nm eq "HASH"
!ll&&!rl&&r
2100
MC/DC0%0/2
$nm and ref $nm eq "HASH"
$nm ref $nm eq "HASH"
Truth table33%1/3
A and B
A= $nmB= ref $nm eq "HASH"
ABresult
0X0
100
111
242 0 ▶ while (my ($name, $meta) = each %$nm) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %$nm) 0 0 0
243 0 $self->named_meta($name, $meta);
244 }
245 }
246 21 ▶ $forceflush && $self->force_flush($forceflush);
Branch: 1 branch
BranchTrueFalseTotal
$forceflush and $self->force_flush($forceflush) 1 20 21
247  
248 21 return $self;
249 }
250  
251  
252 =head2 meta
253  
254 Title : meta
255 Usage : $meta_values = $obj->meta($values_string);
256 Function:
257  
258 Get and set method for the meta data starting from residue
259 position one. Since it is dependent on the length of the
260 sequence, it needs to be manipulated after the sequence.
261  
262 The length of the returned value always matches the length
263 of the sequence, if force_flush() is set. See L<force_flush>.
264  
265 Returns : meta data in a string
266 Args : new value, string, optional
267  
268 =cut
269  
270 15 ▶sub meta {
Subroutine meta: called CC=1 SCAR=0.0
Pod documented
271 15 shift->named_meta($DEFAULT_NAME, shift);
272 }
273  
274 =head2 meta_text
275  
276 Title : meta_text
277 Usage : $meta_values = $obj->meta_text($values_arrayref);
278 Function: Variant of meta() guarantied to return a textual
279 representation of meta data. For details, see L<meta>.
280 Returns : a string
281 Args : new value, optional
282  
283 =cut
284  
285 0 ▶sub meta_text {
Subroutine meta_text: not called CC=1 SCAR=6.9
Pod documented
286 0 shift->meta(shift);
287 }
288  
289 =head2 named_meta
290  
291 Title : named_meta()
292 Usage : $meta_values = $obj->named_meta($name, $values_arrayref);
293 Function: A more general version of meta(). Each meta data set needs
294 to be named. See also L<meta_names>.
295 Returns : a string
296 Args : scalar, name of the meta data set
297 new value, optional
298  
299 =cut
300  
301 55 ▶sub named_meta {
Subroutine named_meta: called CC=8 SCAR=21.3
Pod documented
302 55 my ($self, $name, $value) = @_;
303  
304 55 ▶ $name ||= $DEFAULT_NAME;
Condition33%1/3
$name ||= $Bio::Seq::Meta::DEFAULT_NAME
l!l&&r!l&&!r
5500
MC/DC0%0/2
$name ||= $Bio::Seq::Meta::DEFAULT_NAME
$name $Bio::Seq::Meta::DEFAULT_NAME
Truth table33%1/3
A ||= B
A= $nameB= $Bio::Seq::Meta::DEFAULT_NAME
ABresult
1X1
011
000
305 55 ▶ if( defined $value) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 35 20 55
306  
307 35 ▶ $self->throw("I need a scalar value, not [". ref($value). "]")
Branch: 1 branch
BranchTrueFalseTotal
if ref $value 0 35 35
308 if ref($value);
309  
310 # test for length
311 35 my $diff = $self->length - CORE::length($value);
312 35 ▶ if ($diff > 0) {
Branch: 1 branch
BranchTrueFalseTotal
if ($diff > 0) 3 32 35
313 3 $value .= (" " x $diff);
314 }
315  
316 35 $self->{'_meta'}->{$name} = $value;
317  
318 #$self->_test_gap_positions($name) if $self->verbose > 0;
319 }
320  
321 return " " x $self->length
322 55 ▶ if $self->force_flush && not defined $self->{'_meta'}->{$name};
Branch: 1 branch
BranchTrueFalseTotal
if $self->force_flush and not defined $self->{"_meta"}{$name} 0 55 55
Condition66%2/3
$self->force_flush and not defined $self->{"_meta"}{$name}
!ll&&!rl&&r
4780
MC/DC0%0/2
$self->force_flush and not defined $self->{"_meta"}{$name}
$self->force_flush not defined $self->{"_meta"}{$name}
Truth table66%2/3
A and not(B)
A= $self->force_flushB= not defined $self->{"_meta"}{$name}
ABresult
0X0
100
111
323  
324  
325 55 ▶ $self->_do_flush if $self->force_flush;
Branch: 1 branch
BranchTrueFalseTotal
if $self->force_flush 8 47 55
326  
327 55 return $self->{'_meta'}->{$name};
328 }
329  
330 =head2 _test_gap_positions
331  
332 Title : _test_gap_positions
333 Usage : $meta_values = $obj->_test_gap_positions($name);
334 Function: Internal test for correct position of gap characters.
335 Gap being only '-' this time.
336  
337 This method is called from named_meta() when setting meta
338 data but only if verbose is positive as this can be an
339 expensive process on very long sequences. Set verbose(1) to
340 see warnings when gaps do not align in sequence and meta
341 data and turn them into errors by setting verbose(2).
342  
343 Returns : true on success, prints warnings
344 Args : none
345  
346 =cut
347  
348 0 ▶sub _test_gap_positions {
Subroutine _test_gap_positions: not called CC=6 SCAR=37.4
349 0 my $self = shift;
350 0 my $name = shift;
351 0 my $success = 1;
352  
353 0 ▶ $self->seq || return $success;
Branch: 1 branch
BranchTrueFalseTotal
$self->seq or return $success 0 0 0
354 0 my $len = CORE::length($self->seq);
355 0 ▶ for (my $i=0; $i < $len; $i++) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i < $len) 0 0 0
356 0 my $s = substr $self->{seq}, $i, 1;
357 0 my $m = substr $self->{_meta}->{$name}, $i, 1;
358 0 ▶ $self->warn("Gap mismatch [$m/$s] in column [". ($i+1). "] of [$name] meta data in seq [". $self->id. "]")
Branch: 1 branch
BranchTrueFalseTotal
if $s eq $Bio::Seq::Meta::META_GAP and $s ne $m 0 0 0
Condition0%0/9
$s eq $Bio::Seq::Meta::META_GAP && $s ne $m && ($self->warn("Gap mismatch [$m/$s] in column [" . ($i + 1) . "] of [$name] meta data in seq [" . $self->id . ']') && ($success = 0))
!ll&&!rl&&r
000
$s eq $Bio::Seq::Meta::META_GAP and $s ne $m
!ll&&!rl&&r
000
$self->warn("Gap mismatch [$m/$s] in column [" . ($i + 1) . "] of [$name] meta data in seq [" . $self->id . ']') and $success = 0
!ll&&!rl&&r
000
MC/DC0%0/4
$s eq $Bio::Seq::Meta::META_GAP && $s ne $m && ($self->warn("Gap mismatch [$m/$s] in column [" . ($i + 1) . "] of [$name] meta data in seq [" . $self->id . ']') && ($success = 0))
$s eq $Bio::Seq::Meta::META_GAP $s ne $m $self->warn("Gap mismatch [$m/$s] in column [" . ($i + 1) . "] of [$name] meta data in seq [" . $self->id . ']') $success = 0
Truth table0%0/5
A and B && C and D
A= $s eq $Bio::Seq::Meta::META_GAPB= $s ne $mC= $self->warn("Gap mismatch [$m/$s] in column [" . ($i + 1) . "] of [$name] meta data in seq [" . $self->id . ']')D= $success = 0
ABCDresult
0XXX0
10XX0
110X0
11100
11111
359 and $success = 0
360 if ($s eq $META_GAP) && $s ne $m;
361 }
362 0 return $success;
363 }
364  
365 =head2 named_meta_text
366  
367 Title : named_meta_text()
368 Usage : $meta_values = $obj->named_meta_text($name, $values_arrayref);
369 Function: Variant of named_meta() guarantied to return a textual
370 representation of the named meta data.
371 For details, see L<meta>.
372 Returns : a string
373 Args : scalar, name of the meta data set
374 new value, optional
375  
376 =cut
377  
378 0 ▶sub named_meta_text {
Subroutine named_meta_text: not called CC=1 SCAR=6.9
Pod documented
379 0 shift->named_meta(@_);
380 }
381  
382 =head2 submeta
383  
384 Title : submeta
385 Usage : $subset_of_meta_values = $obj->submeta(10, 20, $value_string);
386 $subset_of_meta_values = $obj->submeta(10, undef, $value_string);
387 Function:
388  
389 Get and set method for meta data for subsequences.
390  
391 Numbering starts from 1 and the number is inclusive, ie 1-2
392 are the first two residue of the sequence. Start cannot be
393 larger than end but can be equal.
394  
395 If the second argument is missing the returned values
396 should extend to the end of the sequence.
397  
398 The return value may be a string or an array reference,
399 depending on the implementation. If in doubt, use
400 submeta_text() which is a variant guarantied to return a
401 string. See L<submeta_text>.
402  
403 Returns : A reference to an array or a string
404 Args : integer, start position
405 integer, end position, optional when a third argument present
406 new value, optional
407  
408 =cut
409  
410 5 ▶sub submeta {
Subroutine submeta: called CC=1 SCAR=0.0
Pod documented
411 5 shift->named_submeta($DEFAULT_NAME, @_);
412 }
413  
414 =head2 submeta_text
415  
416 Title : submeta_text
417 Usage : $meta_values = $obj->submeta_text(20, $value_string);
418 Function: Variant of submeta() guarantied to return a textual
419 representation of meta data. For details, see L<meta>.
420 Returns : a string
421 Args : new value, optional
422  
423  
424 =cut
425  
426 0 ▶sub submeta_text {
Subroutine submeta_text: not called CC=1 SCAR=6.9
Pod documented
427 0 shift->submeta(@_);
428 }
429  
430 =head2 named_submeta
431  
432 Title : named_submeta
433 Usage : $subset_of_meta_values = $obj->named_submeta($name, 10, 20, $value_string);
434 $subset_of_meta_values = $obj->named_submeta($name, 10);
435 Function: Variant of submeta() guarantied to return a textual
436 representation of meta data. For details, see L<meta>.
437 Returns : A reference to an array or a string
438 Args : scalar, name of the meta data set
439 integer, start position
440 integer, end position, optional when a third argument present
441 new value, optional
442  
443 =cut
444  
445 8 ▶sub named_submeta {
Subroutine named_submeta: called CC=13 SCAR=26.9
Pod documented
446 8 my ($self, $name, $start, $end, $value) = @_;
447  
448 8 ▶ $name ||= $DEFAULT_NAME;
Condition33%1/3
$name ||= $Bio::Seq::Meta::DEFAULT_NAME
l!l&&r!l&&!r
800
MC/DC0%0/2
$name ||= $Bio::Seq::Meta::DEFAULT_NAME
$name $Bio::Seq::Meta::DEFAULT_NAME
Truth table33%1/3
A ||= B
A= $nameB= $Bio::Seq::Meta::DEFAULT_NAME
ABresult
1X1
011
000
449 8 ▶ $start ||=1;
Condition100%2/2
$start ||= 1
l!l
71
MC/DC100%1/1
$start ||= 1
$start
Truth table100%2/2
A
A= $start
Aresult
11
00
450  
451  
452 8 ▶ $start =~ /^[+]?\d+$/ and $start > 0 or
Branch: 1 branch
BranchTrueFalseTotal
$start =~ /^[+]?\d+$/ and $start > 0 or $self->throw("Need at least a positive integer start value") 8 0 8
Condition33%1/3
$start =~ /^[+]?\d+$/ and $start > 0
!ll&&!rl&&r
008
MC/DC0%0/2
$start =~ /^[+]?\d+$/ and $start > 0
$start =~ /^[+]?\d+$/ $start > 0
Truth table33%1/3
A and B
A= $start =~ /^[+]?\d+$/B= $start > 0
ABresult
0X0
100
111
453 $self->throw("Need at least a positive integer start value");
454  
455 8 ▶ if ($value) {
Branch: 1 branch
BranchTrueFalseTotal
if ($value) { } 3 5 8
456 3 ▶ $end ||= $start+length($value)-1;
Condition66%2/3
$end ||= $start + length($value) - 1
l!l&&r!l&&!r
120
MC/DC0%0/2
$end ||= $start + length($value) - 1
$end $start + length($value) - 1
Truth table66%2/3
A ||= B
A= $endB= $start + length($value) - 1
ABresult
1X1
011
000
457 3 ▶ $self->warn("You are setting meta values beyond the length of the sequence\n".
Branch: 1 branch
BranchTrueFalseTotal
if $start > length $self->seq 0 3 3
458 "[$start > ". length($self->seq)."] in sequence ". $self->id)
459 if $start > length $self->seq;
460  
461 # pad meta data if needed
462 3 ▶ $self->{_meta}->{$name} = () unless defined $self->{_meta}->{$name};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"_meta"}{$name} 0 3 3
463 3 ▶ if (length($self->{_meta}->{$name}) < $start) {
Branch: 1 branch
BranchTrueFalseTotal
if (length $self->{"_meta"}{$name} < $start) 1 2 3
464 1 $self->{'_meta'}->{$name} .= " " x ( $start - length($self->{'_meta'}->{$name}) -1);
465 }
466  
467 3 my $tail = '';
468 $tail = substr ($self->{_meta}->{$name}, $start-1+length($value))
469 3 ▶ if length($self->{_meta}->{$name}) >= $start-1+length($value);
Branch: 1 branch
BranchTrueFalseTotal
if length $self->{"_meta"}{$name} >= $start - 1 + length($value) 2 1 3
470
471 3 substr ($self->{_meta}->{$name}, --$start) = $value;
472 3 $self->{_meta}->{$name} .= $tail;
473  
474 3 return substr ($self->{_meta}->{$name}, $start, $end - $start + 1);
475  
476 } else {
477  
478 5 ▶ $end or $end = length $self->seq;
Branch: 1 branch
BranchTrueFalseTotal
$end or $end = length $self->seq 3 2 5
479  
480 # pad meta data if needed
481 5 ▶ if (length($self->{_meta}->{$name}) < $end) {
Branch: 1 branch
BranchTrueFalseTotal
if (length $self->{"_meta"}{$name} < $end) 0 5 5
482 0 $self->{'_meta'}->{$name} .= " " x ( $start - length($self->{'_meta'}->{$name}));
483 }
484  
485 5 return substr ($self->{_meta}->{$name}, $start-1, $end - $start + 1)
486 }
487 }
488  
489  
490 =head2 named_submeta_text
491  
492 Title : named_submeta_text
493 Usage : $meta_values = $obj->named_submeta_text($name, 20, $value_string);
494 Function: Variant of submeta() guarantied to return a textual
495 representation of meta data. For details, see L<meta>.
496 Returns : a string
497 Args : scalar, name of the meta data
498 Args : integer, start position, optional
499 integer, end position, optional
500 new value, optional
501  
502 =cut
503  
504 0 ▶sub named_submeta_text {
Subroutine named_submeta_text: not called CC=1 SCAR=6.9
Pod documented
505 0 shift->named_submeta(@_);
506 }
507  
508 =head2 meta_names
509  
510 Title : meta_names
511 Usage : @meta_names = $obj->meta_names()
512 Function: Retrieves an array of meta data set names. The default
513 (unnamed) set name is guarantied to be the first name.
514 Returns : an array of names
515 Args : none
516  
517 =cut
518  
519 19 ▶sub meta_names {
Subroutine meta_names: called CC=4 SCAR=13.9
Pod documented
520 19 my ($self) = @_;
521  
522 19 my @r;
523 19 foreach ( sort keys %{$self->{'_meta'}} ) {
524 27 ▶ push (@r, $_) unless $_ eq $DEFAULT_NAME;
Branch: 1 branch
BranchTrueFalseTotal
unless $_ eq $Bio::Seq::Meta::DEFAULT_NAME 9 18 27
525 }
526 19 ▶ unshift @r, $DEFAULT_NAME if $self->{'_meta'}->{$DEFAULT_NAME};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_meta"}{$Bio::Seq::Meta::DEFAULT_NAME} 12 7 19
527 19 return @r;
528 }
529  
530  
531 =head2 meta_length
532  
533 Title : meta_length()
534 Usage : $meeta_len = $obj->meta_length();
535 Function: return the number of elements in the meta set
536 Returns : integer
537 Args : -
538  
539 =cut
540  
541 2 ▶sub meta_length {
Subroutine meta_length: called CC=1 SCAR=0.0
Pod documented
542 2 my ($self) = @_;
543 2 return $self->named_meta_length($DEFAULT_NAME);
544 }
545  
546  
547 =head2 named_meta_length
548  
549 Title : named_meta_length()
550 Usage : $meta_len = $obj->named_meta_length($name);
551 Function: return the number of elements in the named meta set
552 Returns : integer
553 Args : -
554  
555 =cut
556  
557 48 ▶sub named_meta_length {
Subroutine named_meta_length: called CC=2 SCAR=7.6
Pod documented
558 48 my ($self, $name) = @_;
559 48 ▶ $name ||= $DEFAULT_NAME;
Condition33%1/3
$name ||= $Bio::Seq::Meta::DEFAULT_NAME
l!l&&r!l&&!r
4800
MC/DC0%0/2
$name ||= $Bio::Seq::Meta::DEFAULT_NAME
$name $Bio::Seq::Meta::DEFAULT_NAME
Truth table33%1/3
A ||= B
A= $nameB= $Bio::Seq::Meta::DEFAULT_NAME
ABresult
1X1
011
000
560 48 return length ($self->{'_meta'}->{$name});
561 }
562  
563  
564 =head2 force_flush
565  
566 Title : force_flush()
567 Usage : $force_flush = $obj->force_flush(1);
568 Function: Automatically pad with empty values or truncate meta values
569 to sequence length. Not done by default.
570 Returns : boolean 1 or 0
571 Args : optional boolean value
572  
573 Note that if you turn this forced padding off, the previously padded
574 values are not changed.
575  
576 =cut
577  
578 119 ▶sub force_flush {
Subroutine force_flush: called CC=3 SCAR=11.0
Pod documented
579 119 my ($self, $value) = @_;
580  
581 119 ▶ if (defined $value) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $value) 6 113 119
582 6 ▶ if ($value) {
Branch: 1 branch
BranchTrueFalseTotal
if ($value) { } 4 2 6
583 4 $self->{force_flush} = 1;
584 4 $self->_do_flush;
585 } else {
586 2 $self->{force_flush} = 0;
587 }
588 }
589  
590 119 return $self->{force_flush};
591 }
592  
593  
594 =head2 _do_flush
595  
596 Title : _do_flush
597 Usage :
598 Function: internal method to do the force that meta values are same
599 length as the sequence . Called from L<force_flush>
600 Returns :
601 Args :
602  
603 =cut
604  
605  
606 12 ▶sub _do_flush {
Subroutine _do_flush: called CC=4 SCAR=13.9
607 12 my ($self) = @_;
608  
609 12 foreach my $name ( ('DEFAULT', $self->meta_names) ) {
610  
611 # elongnation
612 22 ▶ if ($self->length > $self->named_meta_length($name)) {
Branch: 2 branches
BranchTrueFalseTotal
if ($self->length > $self->named_meta_length($name)) { } 6 16 22
elsif ($self->length < $self->named_meta_length($name)) { } 2 14 16
613 6 $self->{'_meta'}->{$name} .= $META_GAP x ($self->length - $self->named_meta_length($name)) ;
614 }
615 # truncation
616 elsif ( $self->length < $self->named_meta_length($name) ) {
617 2 $self->{_meta}->{$name} = substr($self->{_meta}->{$name}, 0, $self->length-1);
618 }
619 }
620  
621 }
622  
623  
624 =head2 is_flush
625  
626 Title : is_flush
627 Usage : $is_flush = $obj->is_flush()
628 or $is_flush = $obj->is_flush($my_meta_name)
629 Function: Boolean to tell if all meta values are in
630 flush with the sequence length.
631 Returns true if force_flush() is set
632 Set verbosity to a positive value to see failed meta sets
633 Returns : boolean 1 or 0
634 Args : optional name of the meta set
635  
636 =cut
637  
638 3 ▶sub is_flush {
Subroutine is_flush: called CC=9 SCAR=29.5
Pod documented
639  
640 3 my ($self, $name) = shift;
641  
642 3 ▶ return 1 if $self->force_flush;
Branch: 1 branch
BranchTrueFalseTotal
if $self->force_flush 0 3 3
643  
644 3 my $sticky = '';
645  
646  
647 3 ▶ if ($name) {
Branch: 1 branch
BranchTrueFalseTotal
if ($name) { } 0 3 3
648 0 ▶ $sticky .= "$name " if $self->length != $self->named_meta_length($name);
Branch: 1 branch
BranchTrueFalseTotal
if $self->length != $self->named_meta_length($name) 0 0 0
649 } else {
650 3 foreach my $m ($self->meta_names) {
651 1 ▶ $sticky .= "$m " if ($self->named_meta_length($m) > 0) && ($self->length != $self->named_meta_length($m));
Branch: 1 branch
BranchTrueFalseTotal
if $self->named_meta_length($m) > 0 and $self->length != $self->named_meta_length($m) 0 1 1
Condition33%1/3
$self->named_meta_length($m) > 0 and $self->length != $self->named_meta_length($m)
!ll&&!rl&&r
010
MC/DC0%0/2
$self->named_meta_length($m) > 0 and $self->length != $self->named_meta_length($m)
$self->named_meta_length($m) > 0 $self->length != $self->named_meta_length($m)
Truth table33%1/3
A and B
A= $self->named_meta_length($m) > 0B= $self->length != $self->named_meta_length($m)
ABresult
0X0
100
111
652 }
653 }
654  
655 3 ▶ if ($sticky) {
Branch: 1 branch
BranchTrueFalseTotal
if ($sticky) 0 3 3
656 0 ▶ print "These meta set are not flush: $sticky\n" if $self->verbose;
Branch: 1 branch
BranchTrueFalseTotal
if $self->verbose 0 0 0
657 0 return 0;
658 }
659  
660 3 return 1;
661 }
662  
663  
664 =head1 Bio::PrimarySeqI methods
665  
666 =head2 revcom
667  
668 Title : revcom
669 Usage : $newseq = $seq->revcom();
670 Function: Produces a new Bio::Seq::MetaI implementing object where
671 the order of residues and their meta information is reversed.
672 Returns : A new (fresh) Bio::Seq::Meta object
673 Args : none
674 Throws : if the object returns false on is_flush()
675  
676 Note: The method does nothing to meta values, it reorders them, only.
677  
678 =cut
679  
680 2 ▶sub revcom {
Subroutine revcom: called CC=3 SCAR=11.0
Pod documented
681 2 my $self = shift;
682  
683 2 ▶ $self->throw("Can not get a reverse complement. The object is not flush.")
Branch: 1 branch
BranchTrueFalseTotal
unless $self->is_flush 0 2 2
684 unless $self->is_flush;
685  
686 2 my $new = $self->SUPER::revcom;
687 2 foreach (keys %{$self->{_meta}}) {
688 2 $new->named_meta($_, scalar reverse $self->{_meta}->{$_} );
689 };
690 2 return $new;
691 }
692  
693 =head2 trunc
694  
695 Title : trunc
696 Usage : $subseq = $seq->trunc(10,100);
697 Function: Provides a truncation of a sequence together with meta data
698 Returns : a fresh Bio::Seq::Meta implementing object
699 Args : Two integers denoting first and last residue of the sub-sequence.
700  
701 =cut
702  
703 1 ▶sub trunc {
Subroutine trunc: called CC=8 SCAR=23.1
Pod documented
704 1 my ($self, $start, $end) = @_;
705  
706 # test arguments
707 1 ▶ $start =~ /^[+]?\d+$/ and $start > 0 or
Branch: 1 branch
BranchTrueFalseTotal
$start =~ /^[+]?\d+$/ and $start > 0 or $self->throw("Need at least a positive integer start value as start") 1 0 1
Condition33%1/3
$start =~ /^[+]?\d+$/ and $start > 0
!ll&&!rl&&r
001
MC/DC0%0/2
$start =~ /^[+]?\d+$/ and $start > 0
$start =~ /^[+]?\d+$/ $start > 0
Truth table33%1/3
A and B
A= $start =~ /^[+]?\d+$/B= $start > 0
ABresult
0X0
100
111
708 $self->throw("Need at least a positive integer start value as start");
709 1 ▶ $end =~ /^[+]?\d+$/ and $end > 0 or
Branch: 1 branch
BranchTrueFalseTotal
$end =~ /^[+]?\d+$/ and $end > 0 or $self->throw("Need at least a positive integer start value as end") 1 0 1
Condition33%1/3
$end =~ /^[+]?\d+$/ and $end > 0
!ll&&!rl&&r
001
MC/DC0%0/2
$end =~ /^[+]?\d+$/ and $end > 0
$end =~ /^[+]?\d+$/ $end > 0
Truth table33%1/3
A and B
A= $end =~ /^[+]?\d+$/B= $end > 0
ABresult
0X0
100
111
710 $self->throw("Need at least a positive integer start value as end");
711 1 ▶ $end >= $start or
Branch: 1 branch
BranchTrueFalseTotal
$end >= $start or $self->throw("End position has to be larger or equal to start") 1 0 1
712 $self->throw("End position has to be larger or equal to start");
713 1 ▶ $end <= $self->length or
Branch: 1 branch
BranchTrueFalseTotal
$end <= $self->length or $self->throw("End position can not be larger than sequence length") 1 0 1
714 $self->throw("End position can not be larger than sequence length");
715  
716 1 my $new = $self->SUPER::trunc($start, $end);
717 1 $start--;
718 1 foreach (keys %{$self->{_meta}}) {
719 $new->named_meta($_,
720 1 substr($self->{_meta}->{$_}, $start, $end - $start)
721 );
722 };
723 1 return $new;
724 }
725  
726  
727 0 ▶sub to_string {
Subroutine to_string: not called CC=1 SCAR=6.9
Pod undocumented
728 0 my ($self) = @_;
729 0 my $out = Bio::SeqIO->new(-format=>'metafasta');
730 0 $out->write_seq($self);
731 0 return 1;
732 }
733  
734 11 1;
« Bio/Tools/Spidey/Results.pm ↑ Summary Bio/SeqIO/bsml_sax.pm »