| 1 | package Bio::Phylo::Forest::Tree; | ||||||||||
| 2 | 30 | ▶ | use strict; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 3 | 30 | ▶ | use warnings; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 4 | 30 | ▶ | use Bio::Phylo::Forest::DrawTreeRole; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 5 | 30 | ▶ | use base qw'Bio::Phylo::Forest::DrawTreeRole'; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 6 | { | ||||||||||
| 7 | 30 | my @fields = \( my ( %default, %rooted ) ); | |||||||||
| 8 | |||||||||||
| 9 | =head1 NAME | ||||||||||
| 10 | |||||||||||
| 11 | Bio::Phylo::Forest::Tree - Phylogenetic tree | ||||||||||
| 12 | |||||||||||
| 13 | =head1 SYNOPSIS | ||||||||||
| 14 | |||||||||||
| 15 | # some way to get a tree | ||||||||||
| 16 | use Bio::Phylo::IO; | ||||||||||
| 17 | my $string = '((A,B),C);'; | ||||||||||
| 18 | my $forest = Bio::Phylo::IO->parse( | ||||||||||
| 19 | -format => 'newick', | ||||||||||
| 20 | -string => $string | ||||||||||
| 21 | ); | ||||||||||
| 22 | my $tree = $forest->first; | ||||||||||
| 23 | |||||||||||
| 24 | # do something: | ||||||||||
| 25 | print $tree->calc_imbalance; | ||||||||||
| 26 | |||||||||||
| 27 | # prints "1" | ||||||||||
| 28 | |||||||||||
| 29 | =head1 DESCRIPTION | ||||||||||
| 30 | |||||||||||
| 31 | The package has the getters and setters that alter the | ||||||||||
| 32 | internal state of a tree object. Additional tree-related | ||||||||||
| 33 | behaviours (which are available also) are defined in the | ||||||||||
| 34 | package L<Bio::Phylo::Forest::TreeRole>. | ||||||||||
| 35 | |||||||||||
| 36 | =head1 METHODS | ||||||||||
| 37 | |||||||||||
| 38 | =head2 MUTATORS | ||||||||||
| 39 | |||||||||||
| 40 | =over | ||||||||||
| 41 | |||||||||||
| 42 | =item set_as_unrooted() | ||||||||||
| 43 | |||||||||||
| 44 | Sets tree to be interpreted as unrooted. | ||||||||||
| 45 | |||||||||||
| 46 | Type : Mutator | ||||||||||
| 47 | Title : set_as_unrooted | ||||||||||
| 48 | Usage : $tree->set_as_unrooted; | ||||||||||
| 49 | Function: Sets tree to be interpreted as unrooted. | ||||||||||
| 50 | Returns : $tree | ||||||||||
| 51 | Args : NONE | ||||||||||
| 52 | Comments: This is a flag to indicate that the invocant | ||||||||||
| 53 | is interpreted to be unrooted (regardless of | ||||||||||
| 54 | topology). The object is otherwise unaltered, | ||||||||||
| 55 | this method is only here to capture things such | ||||||||||
| 56 | as the [&U] token in nexus files. | ||||||||||
| 57 | |||||||||||
| 58 | =cut | ||||||||||
| 59 | |||||||||||
| 60 | 2 | ▶ | sub set_as_unrooted { | ||||||||
|
Subroutine
set_as_unrooted: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 61 | 2 | my $self = shift; | |||||||||
| 62 | 2 | $rooted{ $self->get_id } = 1; | |||||||||
| 63 | 2 | return $self; | |||||||||
| 64 | } | ||||||||||
| 65 | |||||||||||
| 66 | =item set_as_default() | ||||||||||
| 67 | |||||||||||
| 68 | Sets tree to be the default tree in a forest | ||||||||||
| 69 | |||||||||||
| 70 | Type : Mutator | ||||||||||
| 71 | Title : set_as_default | ||||||||||
| 72 | Usage : $tree->set_as_default; | ||||||||||
| 73 | Function: Sets tree to be default tree in forest | ||||||||||
| 74 | Returns : $tree | ||||||||||
| 75 | Args : NONE | ||||||||||
| 76 | Comments: This is a flag to indicate that the invocant | ||||||||||
| 77 | is the default tree in a forest, i.e. to | ||||||||||
| 78 | capture the '*' token in nexus files. | ||||||||||
| 79 | |||||||||||
| 80 | =cut | ||||||||||
| 81 | |||||||||||
| 82 | 1 | ▶ | sub set_as_default { | ||||||||
|
Subroutine
set_as_default: called CC=3 SCAR=14.2
Pod
documented
| |||||||||||
| 83 | 1 | my $self = shift; | |||||||||
| 84 | 1 | ▶ | if ( my $forest = $self->_get_container ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 85 | 0 | ▶ | if ( my $tree = $forest->get_default_tree ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 86 | 0 | $tree->set_not_default; | |||||||||
| 87 | } | ||||||||||
| 88 | } | ||||||||||
| 89 | 1 | $default{ $self->get_id } = 1; | |||||||||
| 90 | 1 | return $self; | |||||||||
| 91 | } | ||||||||||
| 92 | |||||||||||
| 93 | =item set_not_default() | ||||||||||
| 94 | |||||||||||
| 95 | Sets tree to NOT be the default tree in a forest | ||||||||||
| 96 | |||||||||||
| 97 | Type : Mutator | ||||||||||
| 98 | Title : set_not_default | ||||||||||
| 99 | Usage : $tree->set_not_default; | ||||||||||
| 100 | Function: Sets tree to not be default tree in forest | ||||||||||
| 101 | Returns : $tree | ||||||||||
| 102 | Args : NONE | ||||||||||
| 103 | Comments: This is a flag to indicate that the invocant | ||||||||||
| 104 | is the default tree in a forest, i.e. to | ||||||||||
| 105 | capture the '*' token in nexus files. | ||||||||||
| 106 | |||||||||||
| 107 | =cut | ||||||||||
| 108 | |||||||||||
| 109 | 0 | ▶ | sub set_not_default { | ||||||||
|
Subroutine
set_not_default: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||
| 110 | 0 | my $self = shift; | |||||||||
| 111 | 0 | $default{ $self->get_id } = 0; | |||||||||
| 112 | 0 | return $self; | |||||||||
| 113 | } | ||||||||||
| 114 | |||||||||||
| 115 | =back | ||||||||||
| 116 | |||||||||||
| 117 | =head2 TESTS | ||||||||||
| 118 | |||||||||||
| 119 | =over | ||||||||||
| 120 | |||||||||||
| 121 | =item is_default() | ||||||||||
| 122 | |||||||||||
| 123 | Test if tree is default tree. | ||||||||||
| 124 | |||||||||||
| 125 | Type : Test | ||||||||||
| 126 | Title : is_default | ||||||||||
| 127 | Usage : if ( $tree->is_default ) { | ||||||||||
| 128 | # do something | ||||||||||
| 129 | } | ||||||||||
| 130 | Function: Tests whether the invocant | ||||||||||
| 131 | object is the default tree in the forest. | ||||||||||
| 132 | Returns : BOOLEAN | ||||||||||
| 133 | Args : NONE | ||||||||||
| 134 | |||||||||||
| 135 | =cut | ||||||||||
| 136 | |||||||||||
| 137 | 152 | ▶ | sub is_default { | ||||||||
|
Subroutine
is_default: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 138 | 152 | my $self = shift; | |||||||||
| 139 | 152 | return !!$default{ $self->get_id }; | |||||||||
| 140 | } | ||||||||||
| 141 | |||||||||||
| 142 | =item is_rooted() | ||||||||||
| 143 | |||||||||||
| 144 | Test if tree is rooted. | ||||||||||
| 145 | |||||||||||
| 146 | Type : Test | ||||||||||
| 147 | Title : is_rooted | ||||||||||
| 148 | Usage : if ( $tree->is_rooted ) { | ||||||||||
| 149 | # do something | ||||||||||
| 150 | } | ||||||||||
| 151 | Function: Tests whether the invocant | ||||||||||
| 152 | object is rooted. | ||||||||||
| 153 | Returns : BOOLEAN | ||||||||||
| 154 | Args : NONE | ||||||||||
| 155 | Comments: A tree is considered unrooted if: | ||||||||||
| 156 | - set_as_unrooted has been set, or | ||||||||||
| 157 | - the basal split is a polytomy | ||||||||||
| 158 | |||||||||||
| 159 | =cut | ||||||||||
| 160 | |||||||||||
| 161 | 3 | ▶ | sub is_rooted { | ||||||||
|
Subroutine
is_rooted: called CC=4 SCAR=14.5
Pod
documented
| |||||||||||
| 162 | 3 | my $self = shift; | |||||||||
| 163 | 3 | my $id = $self->get_id; | |||||||||
| 164 | 3 | ▶ | if ( defined $rooted{$id} ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 165 | 2 | return ! $rooted{$id}; | |||||||||
| 166 | } | ||||||||||
| 167 | 1 | ▶ | if ( my $root = $self->get_root ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 168 | 1 | ▶ | if ( my $children = $root->get_children ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 169 | 1 | return scalar @{$children} <= 2; | |||||||||
| 170 | } | ||||||||||
| 171 | 0 | return 1; | |||||||||
| 172 | } | ||||||||||
| 173 | 0 | return 0; | |||||||||
| 174 | } | ||||||||||
| 175 | |||||||||||
| 176 | # the following methods are purely for internal consumption | ||||||||||
| 177 | 191 | ▶ | sub _cleanup : Destructor { | ||||||||
|
Subroutine
_cleanup: called CC=3 SCAR=11.1
| |||||||||||
| 178 | 191 | my $self = shift; | |||||||||
| 179 | 191 | ▶ | if ( defined( my $id = $self->get_id ) ) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 180 | 191 | for my $field (@fields) { | |||||||||
| 181 | 382 | delete $field->{$id}; | |||||||||
| 182 | } | ||||||||||
| 183 | } | ||||||||||
| 184 | 30 | ▶ | } | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 185 | |||||||||||
| 186 | 2 | ▶ | sub _set_rooted : Clonable { | ||||||||
|
Subroutine
_set_rooted: called CC=1 SCAR=0.0
| |||||||||||
| 187 | 2 | my ( $self, $r ) = @_; | |||||||||
| 188 | 2 | $rooted{$self->get_id} = $r; | |||||||||
| 189 | 2 | return $self; | |||||||||
| 190 | 30 | ▶ | } | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 191 | |||||||||||
| 192 | 2 | ▶ | sub _get_rooted { $rooted{shift->get_id} } | ||||||||
|
Subroutine
_get_rooted: called CC=1 SCAR=0.0
| |||||||||||
| 193 | |||||||||||
| 194 | 2 | ▶ | sub _set_default : Clonable { | ||||||||
|
Subroutine
_set_default: called CC=1 SCAR=0.0
| |||||||||||
| 195 | 2 | my ( $self, $d ) = @_; | |||||||||
| 196 | 2 | $default{$self->get_id} = $d; | |||||||||
| 197 | 2 | return $self; | |||||||||
| 198 | 30 | ▶ | } | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 199 | |||||||||||
| 200 | 2 | ▶ | sub _get_default { $default{shift->get_id} } | ||||||||
|
Subroutine
_get_default: called CC=1 SCAR=0.0
| |||||||||||
| 201 | |||||||||||
| 202 | =back | ||||||||||
| 203 | |||||||||||
| 204 | =cut | ||||||||||
| 205 | |||||||||||
| 206 | # podinherit_insert_token | ||||||||||
| 207 | |||||||||||
| 208 | =head1 SEE ALSO | ||||||||||
| 209 | |||||||||||
| 210 | There is a mailing list at L<https://groups.google.com/forum/#!forum/bio-phylo> | ||||||||||
| 211 | for any user or developer questions and discussions. | ||||||||||
| 212 | |||||||||||
| 213 | =over | ||||||||||
| 214 | |||||||||||
| 215 | =item L<Bio::Phylo::Forest::TreeRole> | ||||||||||
| 216 | |||||||||||
| 217 | The L<Bio::Phylo::Forest::Tree> package inherits from | ||||||||||
| 218 | the L<Bio::Phylo::Forest::TreeRole> package, so the methods defined | ||||||||||
| 219 | therein also apply to trees. | ||||||||||
| 220 | |||||||||||
| 221 | =item L<Bio::Phylo::Manual> | ||||||||||
| 222 | |||||||||||
| 223 | Also see the manual: L<Bio::Phylo::Manual> and L<http://rutgervos.blogspot.com>. | ||||||||||
| 224 | |||||||||||
| 225 | =back | ||||||||||
| 226 | |||||||||||
| 227 | =head1 CITATION | ||||||||||
| 228 | |||||||||||
| 229 | If you use Bio::Phylo in published research, please cite it: | ||||||||||
| 230 | |||||||||||
| 231 | B<Rutger A Vos>, B<Jason Caravas>, B<Klaas Hartmann>, B<Mark A Jensen> | ||||||||||
| 232 | and B<Chase Miller>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. | ||||||||||
| 233 | I<BMC Bioinformatics> B<12>:63. | ||||||||||
| 234 | L<http://dx.doi.org/10.1186/1471-2105-12-63> | ||||||||||
| 235 | |||||||||||
| 236 | =cut | ||||||||||
| 237 | |||||||||||
| 238 | } | ||||||||||
| 239 | 30 | 1; | |||||||||