Phylo/Matrices/Datum.pm

filter: Statementstmt 65.2% 75 / 115 Branchbran 40.9% 18 / 44 Conditioncond 41.1% 7 / 17 MC/DCmcdc 20.0% 2 / 10 Subroutinesub 85.0% 17 / 20 Podpod 100% 8 / 8 totaltotal 59.3% 127 / 214 CC 31 SCAR 29.8
CC
31
Cov
57%
set_annotation
72.0
get_annotation
42.0
set_annotations
9.4
CRAP 19.7
« Phylo/Treedrawer/Pdf.pm ↑ Summary Phylo/Forest/NodeRole.pm »
1 package Bio::Phylo::Matrices::Datum;
2 16 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 16 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 16 ▶use Bio::Phylo::Matrices::DatumRole;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 16 ▶use base qw'Bio::Phylo::Matrices::DatumRole';
Subroutine BEGIN: called CC=1 SCAR=0.0
6 16 ▶use Bio::Phylo::Util::Exceptions 'throw';
Subroutine BEGIN: called CC=1 SCAR=0.0
7 16 ▶use Bio::Phylo::Util::CONSTANT qw'/looks_like/';
Subroutine BEGIN: called CC=1 SCAR=0.0
8  
9 {
10  
11 16 my $logger = __PACKAGE__->get_logger;
12 16 my @fields = \( my ( %weight, %position, %annotations ) );
13  
14 =head1 NAME
15  
16 Bio::Phylo::Matrices::Datum - Character state sequence
17  
18 =head1 SYNOPSIS
19  
20 use Bio::Phylo::Factory;
21 my $fac = Bio::Phylo::Factory->new;
22  
23 # instantiating a datum object...
24 my $datum = $fac->create_datum(
25 -name => 'Tooth comb size,
26 -type => 'STANDARD',
27 -desc => 'number of teeth in lower jaw comb',
28 -pos => 1,
29 -weight => 2,
30 -char => [ 6 ],
31 );
32  
33 # ...and linking it to a taxon object
34 my $taxon = $fac->create_taxon(
35 -name => 'Lemur_catta'
36 );
37 $datum->set_taxon( $taxon );
38  
39 # instantiating a matrix...
40 my $matrix = $fac->create_matrix;
41  
42 # ...and insert datum in matrix
43 $matrix->insert($datum);
44  
45 =head1 DESCRIPTION
46  
47 The datum object models a single observation or a sequence of observations,
48 which can be linked to a taxon object. This package contains the getters
49 and setters that alter the internal state of the datum object. Additional
50 (stateless) behaviours are defined in the L<Bio::Phylo::Matrices::DatumRole>
51 package.
52  
53 =head1 METHODS
54  
55 =head2 MUTATORS
56  
57 =over
58  
59 =item set_weight()
60  
61 Sets invocant weight.
62  
63 Type : Mutator
64 Title : set_weight
65 Usage : $datum->set_weight($weight);
66 Function: Assigns a datum's weight.
67 Returns : Modified object.
68 Args : The $weight argument must be a
69 number in any of Perl's number
70 formats.
71  
72 =cut
73  
74 20 ▶ sub set_weight : Clonable {
Subroutine set_weight: called CC=3 SCAR=11.0
Pod documented
75 20 my ( $self, $weight ) = @_;
76 20 my $id = $self->get_id;
77 20 ▶ if ( looks_like_number $weight ) {
Branch: 2 branches
BranchTrueFalseTotal
if (&looks_like_number($weight)) { } 1 19 20
elsif (defined $weight) { } 1 18 19
78 1 $weight{$id} = $weight;
79 1 $logger->info("setting weight '$weight'");
80 }
81 elsif ( defined $weight ) {
82 1 throw 'BadNumber' => 'Not a number!';
83 }
84 else {
85 18 $weight{$id} = undef;
86 }
87 19 return $self;
88 16 ▶ }
Subroutine BEGIN: called CC=1 SCAR=0.0
89  
90 =item set_position()
91  
92 Set invocant starting position.
93  
94 Type : Mutator
95 Title : set_position
96 Usage : $datum->set_position($pos);
97 Function: Assigns a datum's position.
98 Returns : Modified object.
99 Args : $pos must be an integer.
100  
101 =cut
102  
103 20 ▶ sub set_position : Clonable {
Subroutine set_position: called CC=5 SCAR=16.2
Pod documented
104 20 my ( $self, $pos ) = @_;
105 20 ▶ if ( looks_like_number $pos && $pos >= 1 && $pos / int($pos) == 1 ) {
Branch: 2 branches
BranchTrueFalseTotal
if (&looks_like_number($pos) and $pos >= 1 and $pos / int($pos) == 1) { } 1 19 20
elsif (defined $pos) { } 1 18 19
Condition66%4/6
&looks_like_number($pos) and $pos >= 1 and $pos / int($pos) == 1
!ll&&!rl&&r
1901
&looks_like_number($pos) and $pos >= 1
!ll&&!rl&&r
1901
MC/DC33%1/3
&looks_like_number($pos) and $pos >= 1 and $pos / int($pos) == 1
&looks_like_number($pos) $pos >= 1 $pos / int($pos) == 1
Truth table50%2/4
A and B and C
A= &looks_like_number($pos)B= $pos >= 1C= $pos / int($pos) == 1
ABCresult
0XX0
10X0
1100
1111
106 1 $position{ $self->get_id } = $pos;
107 1 $logger->info("setting position '$pos'");
108 }
109 elsif ( defined $pos ) {
110 1 throw 'BadNumber' => "'$pos' not a positive integer!";
111 }
112 else {
113 18 $position{ $self->get_id } = undef;
114 }
115 19 return $self;
116 16 ▶ }
Subroutine BEGIN: called CC=1 SCAR=0.0
117  
118 =item set_annotation()
119  
120 Sets single annotation.
121  
122 Type : Mutator
123 Title : set_annotation
124 Usage : $datum->set_annotation(
125 -char => 1,
126 -annotation => { -codonpos => 1 }
127 );
128 Function: Assigns an annotation to a
129 character in the datum.
130 Returns : Modified object.
131 Args : Required: -char => $int
132 Optional: -annotation => $hashref
133 Comments: Use this method to annotate
134 a single character. To annotate
135 multiple characters, use
136 'set_annotations' (see below).
137  
138 =cut
139  
140 0 ▶ sub set_annotation {
Subroutine set_annotation: not called CC=8 SCAR=42.8
Pod documented
141 0 my $self = shift;
142 0 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 0 0 0
143 0 my %opt = looks_like_hash @_;
144 0 ▶ if ( not exists $opt{'-char'} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (exists $opt{"-char"}) 0 0 0
145 0 throw 'BadArgs' => "No character to annotate specified!";
146 }
147 0 my $i = $opt{'-char'};
148 0 my $id = $self->get_id;
149 0 my $pos = $self->get_position;
150 0 my $len = $self->get_length;
151 0 ▶ if ( $i > ( $pos + $len ) || $i < $pos ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i > $pos + $len or $i < $pos) 0 0 0
Condition0%0/3
$i > $pos + $len or $i < $pos
l!l&&r!l&&!r
000
MC/DC0%0/2
$i > $pos + $len or $i < $pos
$i > $pos + $len $i < $pos
Truth table0%0/3
A or B
A= $i > $pos + $lenB= $i < $pos
ABresult
1X1
011
000
152 0 throw 'OutOfBounds' => "Specified char ($i) does not exist!";
153 }
154 0 ▶ if ( exists $opt{'-annotation'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opt{'-annotation'}) { } 0 0 0
155 0 my $note = $opt{'-annotation'};
156 0 ▶ $annotations{$id}->[$i] = {} if !$annotations{$id}->[$i];
Branch: 1 branch
BranchTrueFalseTotal
unless $annotations{$id}[$i] 0 0 0
157 0 ▶ while ( my ( $k, $v ) = each %{$note} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %{$note;}) 0 0 0
158 0 $annotations{$id}->[$i]->{$k} = $v;
159 }
160 }
161 else {
162 0 $annotations{$id}->[$i] = undef;
163 }
164 }
165 else {
166 0 throw 'BadArgs' => "No character to annotate specified!";
167 }
168 0 return $self;
169 }
170  
171 =item set_annotations()
172  
173 Sets list of annotations.
174  
175 Type : Mutator
176 Title : set_annotations
177 Usage : $datum->set_annotations(
178 { '-codonpos' => 1 },
179 { '-codonpos' => 2 },
180 { '-codonpos' => 3 },
181 );
182 Function: Assign annotations to
183 characters in the datum.
184 Returns : Modified object.
185 Args : Hash references, where
186 position in the argument
187 list matches that of the
188 specified characters in
189 the character list. If no
190 argument given, annotations
191 are reset.
192 Comments: Use this method to annotate
193 multiple characters. To
194 annotate a single character,
195 use 'set_annotation' (see
196 above).
197  
198 =cut
199  
200 1308 ▶ sub set_annotations : Clonable {
Subroutine set_annotations: called CC=9 SCAR=22.5
Pod documented
201 1308 my $self = shift;
202 1308 my @anno;
203 1308 ▶ if ( scalar @_ == 1 and looks_like_instance( $_[0], 'ARRAY' ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @_ == 1 and &looks_like_instance($_[0], 'ARRAY')) { } 602 706 1308
Condition66%2/3
scalar @_ == 1 and &looks_like_instance($_[0], "ARRAY")
!ll&&!rl&&r
7060602
MC/DC50%1/2
scalar @_ == 1 and &looks_like_instance($_[0], "ARRAY")
scalar @_ == 1 &looks_like_instance($_[0], "ARRAY")
Truth table66%2/3
A and B
A= scalar @_ == 1B= &looks_like_instance($_[0], "ARRAY")
ABresult
0X0
100
111
204 602 @anno = @{ $_[0] };
205 }
206 else {
207 706 @anno = @_;
208 }
209 1308 my $id = $self->get_id;
210 1308 ▶ if (@anno) {
Branch: 1 branch
BranchTrueFalseTotal
if (@anno) { } 584 724 1308
211 584 my $max_index = $self->get_length - 1;
212 584 for my $i ( 0 .. $#anno ) {
213 82243 ▶ if ( $i > $max_index ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i > $max_index) { } 0 82243 82243
214 0 throw 'OutOfBounds' =>
215 "Specified char ($i) does not exist!";
216 }
217 else {
218 82243 ▶ if ( looks_like_instance( $anno[$i], 'HASH' ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (&looks_like_instance($anno[$i], 'HASH')) { } 82243 0 82243
219 $annotations{$id}->[$i] = {}
220 82243 ▶ if !$annotations{$id}->[$i];
Branch: 1 branch
BranchTrueFalseTotal
unless $annotations{$id}[$i] 82243 0 82243
221 82243 ▶ while ( my ( $k, $v ) = each %{ $anno[$i] } ) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each %{$anno[$i];}) 82243 82243 164486
222 82243 $annotations{$id}->[$i]->{$k} = $v;
223 }
224 }
225 else {
226 0 next;
227 }
228 }
229 }
230 }
231 else {
232 724 $annotations{$id} = [];
233 }
234 16 ▶ }
Subroutine BEGIN: called CC=1 SCAR=0.0
235  
236 =back
237  
238 =head2 ACCESSORS
239  
240 =over
241  
242 =item get_weight()
243  
244 Gets invocant weight.
245  
246 Type : Accessor
247 Title : get_weight
248 Usage : my $weight = $datum->get_weight;
249 Function: Retrieves a datum's weight.
250 Returns : FLOAT
251 Args : NONE
252  
253 =cut
254  
255 19 ▶ sub get_weight { $weight{ shift->get_id } }
Subroutine get_weight: called CC=1 SCAR=0.0
Pod documented
256  
257 =item get_position()
258  
259 Gets invocant starting position.
260  
261 Type : Accessor
262 Title : get_position
263 Usage : my $pos = $datum->get_position;
264 Function: Retrieves a datum's position.
265 Returns : a SCALAR integer.
266 Args : NONE
267  
268 =cut
269  
270 2005 ▶ sub get_position { $position{ shift->get_id } }
Subroutine get_position: called CC=1 SCAR=0.0
Pod documented
271  
272 =item get_annotation()
273  
274 Retrieves character annotation (hashref).
275  
276 Type : Accessor
277 Title : get_annotation
278 Usage : $datum->get_annotation(
279 '-char' => 1,
280 '-key' => '-codonpos',
281 );
282 Function: Retrieves an annotation to
283 a character in the datum.
284 Returns : SCALAR or HASH
285 Args : Optional: -char => $int
286 Optional: -key => $key
287  
288 =cut
289  
290 0 ▶ sub get_annotation {
Subroutine get_annotation: not called CC=6 SCAR=37.4
Pod documented
291 0 my $self = shift;
292 0 my $id = $self->get_id;
293 0 ▶ if (@_) {
Branch: 1 branch
BranchTrueFalseTotal
if (@_) { } 0 0 0
294 0 my %opt = looks_like_hash @_;
295 0 ▶ if ( not exists $opt{'-char'} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (exists $opt{"-char"}) 0 0 0
296 0 throw 'BadArgs' =>
297 "No character to return annotation for specified!";
298 }
299 0 my $i = $opt{'-char'};
300 0 my $pos = $self->get_position;
301 0 my $len = $self->get_length;
302 0 ▶ if ( $i < $pos || $i > ( $pos + $len ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i < $pos or $i > $pos + $len) 0 0 0
Condition0%0/3
$i < $pos or $i > $pos + $len
l!l&&r!l&&!r
000
MC/DC0%0/2
$i < $pos or $i > $pos + $len
$i < $pos $i > $pos + $len
Truth table0%0/3
A or B
A= $i < $posB= $i > $pos + $len
ABresult
1X1
011
000
303 0 throw 'OutOfBounds' => "Specified char ($i) does not exist!";
304 }
305 0 ▶ if ( exists $opt{'-key'} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opt{'-key'}) { } 0 0 0
306 0 return $annotations{$id}->[$i]->{ $opt{'-key'} };
307 }
308 else {
309 0 return $annotations{$id}->[$i];
310 }
311 }
312 else {
313 0 return $annotations{$id};
314 }
315 }
316  
317 =item get_annotations()
318  
319 Retrieves character annotations (array ref).
320  
321 Type : Accessor
322 Title : get_annotations
323 Usage : my @anno = @{ $datum->get_annotation() };
324 Function: Retrieves annotations
325 Returns : ARRAY
326 Args : NONE
327  
328 =cut
329  
330 618 ▶ sub get_annotations {
Subroutine get_annotations: called CC=2 SCAR=7.2
Pod documented
331 618 my $self = shift;
332 618 ▶ return $annotations{ $self->get_id } || [];
Condition50%1/2
$annotations{$self->get_id} || []
l!l
6180
MC/DC0%0/1
$annotations{$self->get_id} || []
$annotations{$self->get_id}
Truth table50%1/2
A
A= $annotations{$self->get_id}
Aresult
11
00
333 }
334  
335 724 ▶ sub _cleanup : Destructor {
Subroutine _cleanup: called CC=3 SCAR=11.1
336 724 my $self = shift;
337 724 $logger->info("cleaning up '$self'");
338 724 ▶ if ( defined( my $id = $self->get_id ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $id = $self->get_id)) 724 0 724
339 724 for my $field (@fields) {
340 2172 delete $field->{$id};
341 }
342 }
343 16 ▶ }
Subroutine BEGIN: called CC=1 SCAR=0.0
344
345 0 ▶ sub _update_characters {
Subroutine _update_characters: not called CC=2 SCAR=17.9
346 0 my $self = shift;
347 0 ▶ if ( my $matrix = $self->get_matrix ) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $matrix = $self->get_matrix) 0 0 0
348 0 $matrix->_update_characters;
349 }
350 }
351 }
352  
353 =back
354  
355 =cut
356  
357 # podinherit_insert_token
358  
359 =head1 SEE ALSO
360  
361 There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo>
362 for any user or developer questions and discussions.
363  
364 =over
365  
366 =item L<Bio::Phylo::Matrices::DatumRole>
367  
368 This object inherits from L<Bio::Phylo::Matrices::DatumRole>, so the methods
369 defined therein are also applicable to L<Bio::Phylo::Matrices::Datum> objects.
370  
371 =item L<Bio::Phylo::Manual>
372  
373 Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>.
374  
375 =back
376  
377 =head1 CITATION
378  
379 If you use Bio::Phylo in published research, please cite it:
380  
381 B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen>
382 and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl.
383 I<BMC Bioinformatics> B<12>:63.
384 L<http://dx.doi.org/10.1186/1471-2105-12-63>
385  
386 =cut
387  
388 16 1;
« Phylo/Treedrawer/Pdf.pm ↑ Summary Phylo/Forest/NodeRole.pm »