| 1 | ###################################################### | ||||||||||||||||||||||||||||
| 2 | # Tree.pm | ||||||||||||||||||||||||||||
| 3 | ###################################################### | ||||||||||||||||||||||||||||
| 4 | # Author: Weigang Qiu, Chengzhi Liang, Peter Yang, Thomas Hladish | ||||||||||||||||||||||||||||
| 5 | # $Id: Tree.pm,v 1.62 2007/09/21 23:09:09 rvos Exp $ | ||||||||||||||||||||||||||||
| 6 | |||||||||||||||||||||||||||||
| 7 | #################### START POD DOCUMENTATION ################## | ||||||||||||||||||||||||||||
| 8 | |||||||||||||||||||||||||||||
| 9 | =head1 NAME | ||||||||||||||||||||||||||||
| 10 | |||||||||||||||||||||||||||||
| 11 | Bio::NEXUS::Tree - Provides functions for manipulating trees | ||||||||||||||||||||||||||||
| 12 | |||||||||||||||||||||||||||||
| 13 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||
| 14 | |||||||||||||||||||||||||||||
| 15 | new Bio::NEXUS::Tree; | ||||||||||||||||||||||||||||
| 16 | |||||||||||||||||||||||||||||
| 17 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 18 | |||||||||||||||||||||||||||||
| 19 | Provides a few useful functions for trees. | ||||||||||||||||||||||||||||
| 20 | |||||||||||||||||||||||||||||
| 21 | =head1 FEEDBACK | ||||||||||||||||||||||||||||
| 22 | |||||||||||||||||||||||||||||
| 23 | All feedback (bugs, feature enhancements, etc.) are all greatly appreciated. There are no mailing lists at this time for the Bio::NEXUS::Tree module, so send all relevant contributions to Dr. Weigang Qiu (weigang@genectr.hunter.cuny.edu). | ||||||||||||||||||||||||||||
| 24 | |||||||||||||||||||||||||||||
| 25 | =head1 AUTHORS | ||||||||||||||||||||||||||||
| 26 | |||||||||||||||||||||||||||||
| 27 | Eugene Melamud (melamud@carb.nist.gov) | ||||||||||||||||||||||||||||
| 28 | Thomas Hladish (tjhladish at yahoo) | ||||||||||||||||||||||||||||
| 29 | Weigang Qiu (weigang@genectr.hunter.cuny.edu) | ||||||||||||||||||||||||||||
| 30 | Chengzhi Liang (liangc@umbi.umd.edu) | ||||||||||||||||||||||||||||
| 31 | Peter Yang (pyang@rice.edu) | ||||||||||||||||||||||||||||
| 32 | |||||||||||||||||||||||||||||
| 33 | =head1 METHODS | ||||||||||||||||||||||||||||
| 34 | |||||||||||||||||||||||||||||
| 35 | =cut | ||||||||||||||||||||||||||||
| 36 | |||||||||||||||||||||||||||||
| 37 | package Bio::NEXUS::Tree; | ||||||||||||||||||||||||||||
| 38 | |||||||||||||||||||||||||||||
| 39 | 35 | ▶ | use strict; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 40 | 35 | ▶ | use Bio::NEXUS::Functions; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 41 | 35 | ▶ | use Bio::NEXUS::Node; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 42 | #use Data::Dumper; # XXX this is not used, might as well not import it! | ||||||||||||||||||||||||||||
| 43 | #use Carp; | ||||||||||||||||||||||||||||
| 44 | 35 | ▶ | use Bio::NEXUS::Util::Exceptions; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 45 | 35 | ▶ | use Bio::NEXUS::Util::Logger; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 46 | 35 | ▶ | use vars qw($VERSION $AUTOLOAD); | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 47 | 35 | ▶ | use Bio::NEXUS; $VERSION = $Bio::NEXUS::VERSION; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 48 | |||||||||||||||||||||||||||||
| 49 | 35 | my $logger = Bio::NEXUS::Util::Logger->new(); | |||||||||||||||||||||||||||
| 50 | |||||||||||||||||||||||||||||
| 51 | =head2 new | ||||||||||||||||||||||||||||
| 52 | |||||||||||||||||||||||||||||
| 53 | Title : new | ||||||||||||||||||||||||||||
| 54 | Usage : $tree = new Bio::NEXUS::Tree(); | ||||||||||||||||||||||||||||
| 55 | Function: Creates a new Bio::NEXUS::Tree object | ||||||||||||||||||||||||||||
| 56 | Returns : Bio::NEXUS::Tree object | ||||||||||||||||||||||||||||
| 57 | Args : none | ||||||||||||||||||||||||||||
| 58 | |||||||||||||||||||||||||||||
| 59 | =cut | ||||||||||||||||||||||||||||
| 60 | |||||||||||||||||||||||||||||
| 61 | 84 | ▶ | sub new { | ||||||||||||||||||||||||||
|
Subroutine
new: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 62 | 84 | my ($class) = @_; | |||||||||||||||||||||||||||
| 63 | 84 | my $root_node = new Bio::NEXUS::Node; | |||||||||||||||||||||||||||
| 64 | 84 | my $self = { name => undef, root_node => $root_node }; | |||||||||||||||||||||||||||
| 65 | 84 | bless $self, $class; | |||||||||||||||||||||||||||
| 66 | 84 | return $self; | |||||||||||||||||||||||||||
| 67 | } | ||||||||||||||||||||||||||||
| 68 | |||||||||||||||||||||||||||||
| 69 | =head2 clone | ||||||||||||||||||||||||||||
| 70 | |||||||||||||||||||||||||||||
| 71 | Name : clone | ||||||||||||||||||||||||||||
| 72 | Usage : my $new_tree = $self->clone(); | ||||||||||||||||||||||||||||
| 73 | Function: clone a Bio::NEXUS::Tree (self) object. All the nodes are also cloned. | ||||||||||||||||||||||||||||
| 74 | Returns : new Bio::NEXUS::Tree object | ||||||||||||||||||||||||||||
| 75 | Args : none | ||||||||||||||||||||||||||||
| 76 | |||||||||||||||||||||||||||||
| 77 | =cut | ||||||||||||||||||||||||||||
| 78 | |||||||||||||||||||||||||||||
| 79 | 1 | ▶ | sub clone { | ||||||||||||||||||||||||||
|
Subroutine
clone: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 80 | 1 | my ($self) = @_; | |||||||||||||||||||||||||||
| 81 | 1 | my $class = ref($self); | |||||||||||||||||||||||||||
| 82 | 1 | my $newtree = bless( { %{$self} }, $class ); | |||||||||||||||||||||||||||
| 83 | |||||||||||||||||||||||||||||
| 84 | # clone nodes | ||||||||||||||||||||||||||||
| 85 | 1 | $newtree->set_rootnode( $self->get_rootnode()->clone() ); | |||||||||||||||||||||||||||
| 86 | 1 | return $newtree; | |||||||||||||||||||||||||||
| 87 | } | ||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||
| 89 | =head2 set_rootnode | ||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||
| 91 | Title : set_rootnode | ||||||||||||||||||||||||||||
| 92 | Usage : $tree->set_rootnode($newnode); | ||||||||||||||||||||||||||||
| 93 | Function: Sets the root node to a new node | ||||||||||||||||||||||||||||
| 94 | Returns : none | ||||||||||||||||||||||||||||
| 95 | Args : root node (Bio::NEXUS::Node object) | ||||||||||||||||||||||||||||
| 96 | |||||||||||||||||||||||||||||
| 97 | =cut | ||||||||||||||||||||||||||||
| 98 | |||||||||||||||||||||||||||||
| 99 | 2 | ▶ | sub set_rootnode { | ||||||||||||||||||||||||||
|
Subroutine
set_rootnode: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 100 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 101 | 2 | my $newroot = shift; | |||||||||||||||||||||||||||
| 102 | 2 | $self->{root_node} = $newroot; | |||||||||||||||||||||||||||
| 103 | } | ||||||||||||||||||||||||||||
| 104 | |||||||||||||||||||||||||||||
| 105 | =head2 get_rootnode | ||||||||||||||||||||||||||||
| 106 | |||||||||||||||||||||||||||||
| 107 | Title : get_rootnode | ||||||||||||||||||||||||||||
| 108 | Usage : $node = $tree->get_rootnode(); | ||||||||||||||||||||||||||||
| 109 | Function: Returns the tree root node | ||||||||||||||||||||||||||||
| 110 | Returns : root node (Bio::NEXUS::Node object) | ||||||||||||||||||||||||||||
| 111 | Args : none | ||||||||||||||||||||||||||||
| 112 | |||||||||||||||||||||||||||||
| 113 | =cut | ||||||||||||||||||||||||||||
| 114 | |||||||||||||||||||||||||||||
| 115 | 665 | ▶ | sub get_rootnode { | ||||||||||||||||||||||||||
|
Subroutine
get_rootnode: called CC=2 SCAR=7.1
Pod
documented
| |||||||||||||||||||||||||||||
| 116 | 665 | my $self = shift; | |||||||||||||||||||||||||||
| 117 | 665 | ▶ | if ( defined $self->{'root_node'} ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 118 | 665 | return $self->{'root_node'}; | |||||||||||||||||||||||||||
| 119 | } | ||||||||||||||||||||||||||||
| 120 | } | ||||||||||||||||||||||||||||
| 121 | |||||||||||||||||||||||||||||
| 122 | =begin comment | ||||||||||||||||||||||||||||
| 123 | |||||||||||||||||||||||||||||
| 124 | Title : _parse_newick | ||||||||||||||||||||||||||||
| 125 | Usage : $tree->_parse_newick($tree_string); | ||||||||||||||||||||||||||||
| 126 | Function: Creates a tree out of the existing tree string | ||||||||||||||||||||||||||||
| 127 | Returns : none | ||||||||||||||||||||||||||||
| 128 | Args : array ref of NEXUS 'words' (a newick tree string that has been parsed by &_parse_nexus_words) | ||||||||||||||||||||||||||||
| 129 | |||||||||||||||||||||||||||||
| 130 | =end comment | ||||||||||||||||||||||||||||
| 131 | |||||||||||||||||||||||||||||
| 132 | =cut | ||||||||||||||||||||||||||||
| 133 | |||||||||||||||||||||||||||||
| 134 | 82 | ▶ | sub _parse_newick { | ||||||||||||||||||||||||||
|
Subroutine
_parse_newick: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 135 | 82 | my ( $self, $tree_words ) = @_; | |||||||||||||||||||||||||||
| 136 | |||||||||||||||||||||||||||||
| 137 | 82 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 138 | 82 | $root->_parse_newick($tree_words); | |||||||||||||||||||||||||||
| 139 | 82 | $self->set_depth(); | |||||||||||||||||||||||||||
| 140 | 82 | $self->determine_cladogram(); | |||||||||||||||||||||||||||
| 141 | 82 | return; | |||||||||||||||||||||||||||
| 142 | } | ||||||||||||||||||||||||||||
| 143 | |||||||||||||||||||||||||||||
| 144 | =head2 set_name | ||||||||||||||||||||||||||||
| 145 | |||||||||||||||||||||||||||||
| 146 | Title : set_name | ||||||||||||||||||||||||||||
| 147 | Usage : $tree->set_name($name); | ||||||||||||||||||||||||||||
| 148 | Function: Sets the tree name | ||||||||||||||||||||||||||||
| 149 | Returns : none | ||||||||||||||||||||||||||||
| 150 | Args : name (string) | ||||||||||||||||||||||||||||
| 151 | |||||||||||||||||||||||||||||
| 152 | =cut | ||||||||||||||||||||||||||||
| 153 | |||||||||||||||||||||||||||||
| 154 | 102 | ▶ | sub set_name { | ||||||||||||||||||||||||||
|
Subroutine
set_name: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 155 | 102 | my ( $self, $name ) = @_; | |||||||||||||||||||||||||||
| 156 | 102 | $self->{'name'} = $name; | |||||||||||||||||||||||||||
| 157 | } | ||||||||||||||||||||||||||||
| 158 | |||||||||||||||||||||||||||||
| 159 | =head2 get_name | ||||||||||||||||||||||||||||
| 160 | |||||||||||||||||||||||||||||
| 161 | Title : get_name | ||||||||||||||||||||||||||||
| 162 | Usage : $name = $tree->get_name(); | ||||||||||||||||||||||||||||
| 163 | Function: Returns the tree's name | ||||||||||||||||||||||||||||
| 164 | Returns : name (string) or undef if name doesn't exist | ||||||||||||||||||||||||||||
| 165 | Args : none | ||||||||||||||||||||||||||||
| 166 | |||||||||||||||||||||||||||||
| 167 | =cut | ||||||||||||||||||||||||||||
| 168 | |||||||||||||||||||||||||||||
| 169 | 446 | ▶ | sub get_name { | ||||||||||||||||||||||||||
|
Subroutine
get_name: called CC=2 SCAR=8.1
Pod
documented
| |||||||||||||||||||||||||||||
| 170 | 446 | ▶ | if ( defined $_[0]->{'name'} ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 171 | 446 | return $_[0]->{'name'}; | |||||||||||||||||||||||||||
| 172 | } | ||||||||||||||||||||||||||||
| 173 | else { | ||||||||||||||||||||||||||||
| 174 | 0 | return undef; | |||||||||||||||||||||||||||
| 175 | } | ||||||||||||||||||||||||||||
| 176 | } | ||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||
| 178 | =head2 set_as_default | ||||||||||||||||||||||||||||
| 179 | |||||||||||||||||||||||||||||
| 180 | Title : set_as_default | ||||||||||||||||||||||||||||
| 181 | Usage : $tree->set_as_default(); | ||||||||||||||||||||||||||||
| 182 | Function: assigns is_default variable for this object to 1. (default : 0) | ||||||||||||||||||||||||||||
| 183 | Returns : none | ||||||||||||||||||||||||||||
| 184 | Args : none | ||||||||||||||||||||||||||||
| 185 | |||||||||||||||||||||||||||||
| 186 | =cut | ||||||||||||||||||||||||||||
| 187 | |||||||||||||||||||||||||||||
| 188 | 1 | ▶ | sub set_as_default { | ||||||||||||||||||||||||||
|
Subroutine
set_as_default: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 189 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 190 | 1 | $self->{'is_default'} = 1; | |||||||||||||||||||||||||||
| 191 | } | ||||||||||||||||||||||||||||
| 192 | |||||||||||||||||||||||||||||
| 193 | =head2 is_default | ||||||||||||||||||||||||||||
| 194 | |||||||||||||||||||||||||||||
| 195 | Title : is_default | ||||||||||||||||||||||||||||
| 196 | Usage : $is_default_tree = $tree->is_default(); | ||||||||||||||||||||||||||||
| 197 | Function: check whether the tree is assigned as the default. | ||||||||||||||||||||||||||||
| 198 | Returns : 0 (false) or 1 (true) | ||||||||||||||||||||||||||||
| 199 | Args : none | ||||||||||||||||||||||||||||
| 200 | |||||||||||||||||||||||||||||
| 201 | =cut | ||||||||||||||||||||||||||||
| 202 | |||||||||||||||||||||||||||||
| 203 | 0 | ▶ | sub is_default { | ||||||||||||||||||||||||||
|
Subroutine
is_default: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 204 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 205 | 0 | return $self->{'is_default'}; | |||||||||||||||||||||||||||
| 206 | } | ||||||||||||||||||||||||||||
| 207 | |||||||||||||||||||||||||||||
| 208 | =head2 set_as_unrooted | ||||||||||||||||||||||||||||
| 209 | |||||||||||||||||||||||||||||
| 210 | Title : set_as_unrooted | ||||||||||||||||||||||||||||
| 211 | Usage : $tree->set_as_unrooted(); | ||||||||||||||||||||||||||||
| 212 | Function: assigns is_unrooted variable for this object to 1. (default : 0) | ||||||||||||||||||||||||||||
| 213 | Returns : none | ||||||||||||||||||||||||||||
| 214 | Args : none | ||||||||||||||||||||||||||||
| 215 | |||||||||||||||||||||||||||||
| 216 | =cut | ||||||||||||||||||||||||||||
| 217 | |||||||||||||||||||||||||||||
| 218 | 0 | ▶ | sub set_as_unrooted { | ||||||||||||||||||||||||||
|
Subroutine
set_as_unrooted: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 219 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 220 | 0 | $self->{'is_unrooted'} = 1; | |||||||||||||||||||||||||||
| 221 | } | ||||||||||||||||||||||||||||
| 222 | |||||||||||||||||||||||||||||
| 223 | =head2 is_rooted | ||||||||||||||||||||||||||||
| 224 | |||||||||||||||||||||||||||||
| 225 | Title : is_rooted | ||||||||||||||||||||||||||||
| 226 | Usage : $is_rooted_tree = $tree->is_rooted(); | ||||||||||||||||||||||||||||
| 227 | Function: Check whether the tree is rooted. | ||||||||||||||||||||||||||||
| 228 | Returns : 0 (false) or 1 (true) | ||||||||||||||||||||||||||||
| 229 | Args : none | ||||||||||||||||||||||||||||
| 230 | |||||||||||||||||||||||||||||
| 231 | =cut | ||||||||||||||||||||||||||||
| 232 | |||||||||||||||||||||||||||||
| 233 | 0 | ▶ | sub is_rooted { | ||||||||||||||||||||||||||
|
Subroutine
is_rooted: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 234 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 235 | 0 | return !$self->{'is_unrooted'}; | |||||||||||||||||||||||||||
| 236 | } | ||||||||||||||||||||||||||||
| 237 | |||||||||||||||||||||||||||||
| 238 | =head2 determine_cladogram | ||||||||||||||||||||||||||||
| 239 | |||||||||||||||||||||||||||||
| 240 | Title : determine_cladogram | ||||||||||||||||||||||||||||
| 241 | Usage : $tree->determine_cladogram(); | ||||||||||||||||||||||||||||
| 242 | Function: Determine if a tree is a cladogram or not (that is, whether branch lengths are present) | ||||||||||||||||||||||||||||
| 243 | Returns : none | ||||||||||||||||||||||||||||
| 244 | Args : none | ||||||||||||||||||||||||||||
| 245 | |||||||||||||||||||||||||||||
| 246 | =cut | ||||||||||||||||||||||||||||
| 247 | |||||||||||||||||||||||||||||
| 248 | 82 | ▶ | sub determine_cladogram { | ||||||||||||||||||||||||||
|
Subroutine
determine_cladogram: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 249 | 82 | my $self = shift; | |||||||||||||||||||||||||||
| 250 | 82 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 251 | 82 | ▶ | if ( $root->find_lengths() ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 252 | 66 | $self->{'is_cladogram'} = 0; | |||||||||||||||||||||||||||
| 253 | } | ||||||||||||||||||||||||||||
| 254 | else { | ||||||||||||||||||||||||||||
| 255 | 16 | $self->{'is_cladogram'} = 1; | |||||||||||||||||||||||||||
| 256 | } | ||||||||||||||||||||||||||||
| 257 | } | ||||||||||||||||||||||||||||
| 258 | |||||||||||||||||||||||||||||
| 259 | =head2 set_output_format | ||||||||||||||||||||||||||||
| 260 | |||||||||||||||||||||||||||||
| 261 | Title : set_output_format | ||||||||||||||||||||||||||||
| 262 | Usage : $tree->set_output_format('STD'); | ||||||||||||||||||||||||||||
| 263 | Function: Sets the output format for the Tree, (options : STD or NHX) | ||||||||||||||||||||||||||||
| 264 | Returns : none | ||||||||||||||||||||||||||||
| 265 | Args : string: 'STD' or 'NHX' | ||||||||||||||||||||||||||||
| 266 | |||||||||||||||||||||||||||||
| 267 | =cut | ||||||||||||||||||||||||||||
| 268 | |||||||||||||||||||||||||||||
| 269 | 0 | ▶ | sub set_output_format { | ||||||||||||||||||||||||||
|
Subroutine
set_output_format: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 270 | 0 | my ( $self, $format ) = @_; | |||||||||||||||||||||||||||
| 271 | 0 | $self->{'_out_format'} = $format; | |||||||||||||||||||||||||||
| 272 | } | ||||||||||||||||||||||||||||
| 273 | |||||||||||||||||||||||||||||
| 274 | =head2 get_output_format | ||||||||||||||||||||||||||||
| 275 | |||||||||||||||||||||||||||||
| 276 | Title : get_output_format | ||||||||||||||||||||||||||||
| 277 | Usage : $output_format = $tree->get_output_format(); | ||||||||||||||||||||||||||||
| 278 | Function: Returns the output format for the Tree, (options : STD or NHX) | ||||||||||||||||||||||||||||
| 279 | Returns : string: 'STD' or 'NHX' | ||||||||||||||||||||||||||||
| 280 | Args : none | ||||||||||||||||||||||||||||
| 281 | |||||||||||||||||||||||||||||
| 282 | =cut | ||||||||||||||||||||||||||||
| 283 | |||||||||||||||||||||||||||||
| 284 | 92 | ▶ | sub get_output_format { | ||||||||||||||||||||||||||
|
Subroutine
get_output_format: called CC=4 SCAR=13.9
Pod
documented
| |||||||||||||||||||||||||||||
| 285 | 92 | my ($self) = @_; | |||||||||||||||||||||||||||
| 286 | 92 | ▶ | if ( defined $self->{_out_format} ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 287 | 9 | return $self->{_out_format}; | |||||||||||||||||||||||||||
| 288 | } | ||||||||||||||||||||||||||||
| 289 | else { | ||||||||||||||||||||||||||||
| 290 | 83 | my $format = 'STD'; | |||||||||||||||||||||||||||
| 291 | 83 | my $nodes = $self->get_nodes(); | |||||||||||||||||||||||||||
| 292 | 83 | my @otus; | |||||||||||||||||||||||||||
| 293 | 83 | for my $node ( @{$nodes} ) { | |||||||||||||||||||||||||||
| 294 | 1020 | ▶ | if ( $node->{is_nhx} ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 295 | 8 | $format = 'NHX'; | |||||||||||||||||||||||||||
| 296 | 8 | last; | |||||||||||||||||||||||||||
| 297 | } | ||||||||||||||||||||||||||||
| 298 | } | ||||||||||||||||||||||||||||
| 299 | 83 | $self->{_out_format} = $format; | |||||||||||||||||||||||||||
| 300 | } | ||||||||||||||||||||||||||||
| 301 | 83 | return $self->{_out_format}; | |||||||||||||||||||||||||||
| 302 | } | ||||||||||||||||||||||||||||
| 303 | |||||||||||||||||||||||||||||
| 304 | =head2 is_cladogram | ||||||||||||||||||||||||||||
| 305 | |||||||||||||||||||||||||||||
| 306 | Title : is_cladogram | ||||||||||||||||||||||||||||
| 307 | Usage : &dothis() if $tree->is_cladogram(); | ||||||||||||||||||||||||||||
| 308 | Function: Returns whether tree is a cladogram or not | ||||||||||||||||||||||||||||
| 309 | Returns : 0 (no) or 1 (yes) | ||||||||||||||||||||||||||||
| 310 | Args : none | ||||||||||||||||||||||||||||
| 311 | |||||||||||||||||||||||||||||
| 312 | =cut | ||||||||||||||||||||||||||||
| 313 | |||||||||||||||||||||||||||||
| 314 | 0 | ▶ | sub is_cladogram { | ||||||||||||||||||||||||||
|
Subroutine
is_cladogram: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 315 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 316 | 0 | return $self->{'is_cladogram'}; | |||||||||||||||||||||||||||
| 317 | } | ||||||||||||||||||||||||||||
| 318 | |||||||||||||||||||||||||||||
| 319 | =head2 as_string | ||||||||||||||||||||||||||||
| 320 | |||||||||||||||||||||||||||||
| 321 | Title : as_string | ||||||||||||||||||||||||||||
| 322 | Usage : $treestring = $tree->as_string(); | ||||||||||||||||||||||||||||
| 323 | Function: Returns the tree as a string | ||||||||||||||||||||||||||||
| 324 | Returns : tree string (string) | ||||||||||||||||||||||||||||
| 325 | Args : none | ||||||||||||||||||||||||||||
| 326 | |||||||||||||||||||||||||||||
| 327 | =cut | ||||||||||||||||||||||||||||
| 328 | |||||||||||||||||||||||||||||
| 329 | 88 | ▶ | sub as_string { | ||||||||||||||||||||||||||
|
Subroutine
as_string: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 330 | 88 | my $self = shift; | |||||||||||||||||||||||||||
| 331 | 88 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 332 | 88 | my $string; | |||||||||||||||||||||||||||
| 333 | 88 | $root->to_string( \$string, 0, $self->get_output_format ); | |||||||||||||||||||||||||||
| 334 | 88 | $string =~ s/\,$/\;/; | |||||||||||||||||||||||||||
| 335 | 88 | return $string; | |||||||||||||||||||||||||||
| 336 | } | ||||||||||||||||||||||||||||
| 337 | |||||||||||||||||||||||||||||
| 338 | =head2 as_string_inodes_nameless | ||||||||||||||||||||||||||||
| 339 | |||||||||||||||||||||||||||||
| 340 | Title : as_string_inodes_nameless | ||||||||||||||||||||||||||||
| 341 | Usage : $treestring = $tree->as_string_inodes_nameless(); | ||||||||||||||||||||||||||||
| 342 | Function: Returns the tree as a string without internal node names | ||||||||||||||||||||||||||||
| 343 | Returns : tree string (string) | ||||||||||||||||||||||||||||
| 344 | Args : none | ||||||||||||||||||||||||||||
| 345 | |||||||||||||||||||||||||||||
| 346 | =cut | ||||||||||||||||||||||||||||
| 347 | |||||||||||||||||||||||||||||
| 348 | 4 | ▶ | sub as_string_inodes_nameless { | ||||||||||||||||||||||||||
|
Subroutine
as_string_inodes_nameless: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 349 | 4 | my $self = shift; | |||||||||||||||||||||||||||
| 350 | 4 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 351 | 4 | my $string; | |||||||||||||||||||||||||||
| 352 | 4 | $root->to_string( \$string, 1, $self->get_output_format ); | |||||||||||||||||||||||||||
| 353 | 4 | $string =~ s/\,$/\;/; | |||||||||||||||||||||||||||
| 354 | 4 | return $string; | |||||||||||||||||||||||||||
| 355 | } | ||||||||||||||||||||||||||||
| 356 | |||||||||||||||||||||||||||||
| 357 | =head2 get_nodes | ||||||||||||||||||||||||||||
| 358 | |||||||||||||||||||||||||||||
| 359 | Title : get_nodes | ||||||||||||||||||||||||||||
| 360 | Usage : @nodes = @{$tree->get_nodes()}; | ||||||||||||||||||||||||||||
| 361 | Function: Returns the list of ALL nodes in the tree | ||||||||||||||||||||||||||||
| 362 | Returns : reference to array of nodes (Bio::NEXUS::Node objects) | ||||||||||||||||||||||||||||
| 363 | Args : none | ||||||||||||||||||||||||||||
| 364 | |||||||||||||||||||||||||||||
| 365 | =cut | ||||||||||||||||||||||||||||
| 366 | |||||||||||||||||||||||||||||
| 367 | 239 | ▶ | sub get_nodes { | ||||||||||||||||||||||||||
|
Subroutine
get_nodes: called CC=3 SCAR=11.0
Pod
documented
| |||||||||||||||||||||||||||||
| 368 | 239 | my $self = shift; | |||||||||||||||||||||||||||
| 369 | 239 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 370 | 239 | my @nodes; | |||||||||||||||||||||||||||
| 371 | 239 | my $i = 1; | |||||||||||||||||||||||||||
| 372 | 239 | $root->walk( \@nodes, \$i ); | |||||||||||||||||||||||||||
| 373 | 239 | ▶ | $root->set_name('root') | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
not $root->get_name or $root->get_name =~ /^inode1/
MC/DC50%1/2
not $root->get_name or $root->get_name =~ /^inode1/
not $root->get_name
$root->get_name =~ /^inode1/
Truth table66%2/3
not(A) or B
A= not $root->get_nameB= $root->get_name =~ /^inode1/
| |||||||||||||||||||||||||||||
| 374 | if !$root->get_name() || $root->get_name() =~ /^inode1/; | ||||||||||||||||||||||||||||
| 375 | 239 | return \@nodes; | |||||||||||||||||||||||||||
| 376 | } | ||||||||||||||||||||||||||||
| 377 | |||||||||||||||||||||||||||||
| 378 | =head2 get_node_names | ||||||||||||||||||||||||||||
| 379 | |||||||||||||||||||||||||||||
| 380 | Title : get_node_names | ||||||||||||||||||||||||||||
| 381 | Usage : @otu_names = @{$tree->get_node_names()}; | ||||||||||||||||||||||||||||
| 382 | Function: Returns the list of names of otus (terminal nodes) | ||||||||||||||||||||||||||||
| 383 | Returns : array ref of node names | ||||||||||||||||||||||||||||
| 384 | Args : none | ||||||||||||||||||||||||||||
| 385 | |||||||||||||||||||||||||||||
| 386 | =cut | ||||||||||||||||||||||||||||
| 387 | |||||||||||||||||||||||||||||
| 388 | 33 | ▶ | sub get_node_names { | ||||||||||||||||||||||||||
|
Subroutine
get_node_names: called CC=3 SCAR=11.0
Pod
documented
| |||||||||||||||||||||||||||||
| 389 | 33 | my $self = shift; | |||||||||||||||||||||||||||
| 390 | 33 | my $nodes = $self->get_nodes(); | |||||||||||||||||||||||||||
| 391 | 33 | my @otus; | |||||||||||||||||||||||||||
| 392 | 33 | for my $node ( @{$nodes} ) { | |||||||||||||||||||||||||||
| 393 | 404 | ▶ | if ( $node->is_otu() ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 394 | 229 | push @otus, $node->get_name(); | |||||||||||||||||||||||||||
| 395 | } | ||||||||||||||||||||||||||||
| 396 | } | ||||||||||||||||||||||||||||
| 397 | 33 | return \@otus; | |||||||||||||||||||||||||||
| 398 | } | ||||||||||||||||||||||||||||
| 399 | |||||||||||||||||||||||||||||
| 400 | =head2 get_distances | ||||||||||||||||||||||||||||
| 401 | |||||||||||||||||||||||||||||
| 402 | Title : get_distances | ||||||||||||||||||||||||||||
| 403 | Usage : %distances = %{$tree->get_distances()}; | ||||||||||||||||||||||||||||
| 404 | Function: Finds the distances from the root node for all OTUs | ||||||||||||||||||||||||||||
| 405 | Returns : reference to a hash of OTU names as keys and distances as values | ||||||||||||||||||||||||||||
| 406 | Args : none | ||||||||||||||||||||||||||||
| 407 | |||||||||||||||||||||||||||||
| 408 | =cut | ||||||||||||||||||||||||||||
| 409 | |||||||||||||||||||||||||||||
| 410 | 0 | ▶ | sub get_distances { | ||||||||||||||||||||||||||
|
Subroutine
get_distances: not called CC=2 SCAR=17.9
Pod
documented
| |||||||||||||||||||||||||||||
| 411 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 412 | 0 | my $nodes = $self->get_nodes(); | |||||||||||||||||||||||||||
| 413 | 0 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 414 | 0 | my %distances; | |||||||||||||||||||||||||||
| 415 | 0 | for my $node ( @{$nodes} ) { | |||||||||||||||||||||||||||
| 416 | 0 | $distances{ $node->get_name() } = $root->get_distance($node); | |||||||||||||||||||||||||||
| 417 | } | ||||||||||||||||||||||||||||
| 418 | 0 | return \%distances; | |||||||||||||||||||||||||||
| 419 | } | ||||||||||||||||||||||||||||
| 420 | |||||||||||||||||||||||||||||
| 421 | =head2 get_tree_length | ||||||||||||||||||||||||||||
| 422 | |||||||||||||||||||||||||||||
| 423 | Title : get_tree_length | ||||||||||||||||||||||||||||
| 424 | Usage : $tre_length = $self->get_tree_length; | ||||||||||||||||||||||||||||
| 425 | Function: Gets the total branch lengths in the tree. | ||||||||||||||||||||||||||||
| 426 | Returns : total branch length | ||||||||||||||||||||||||||||
| 427 | Args : none | ||||||||||||||||||||||||||||
| 428 | |||||||||||||||||||||||||||||
| 429 | =cut | ||||||||||||||||||||||||||||
| 430 | |||||||||||||||||||||||||||||
| 431 | 2 | ▶ | sub get_tree_length { | ||||||||||||||||||||||||||
|
Subroutine
get_tree_length: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 432 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 433 | 2 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 434 | 2 | return $root->get_total_length(); | |||||||||||||||||||||||||||
| 435 | } | ||||||||||||||||||||||||||||
| 436 | |||||||||||||||||||||||||||||
| 437 | =head2 get_support_values | ||||||||||||||||||||||||||||
| 438 | |||||||||||||||||||||||||||||
| 439 | Title : get_support_values | ||||||||||||||||||||||||||||
| 440 | Usage : %bootstraps = %{$tree->get_support_values()}; | ||||||||||||||||||||||||||||
| 441 | Function: Finds all branch support values for all OTUs | ||||||||||||||||||||||||||||
| 442 | Returns : reference to a hash where OTU names are keys and branch support values are values | ||||||||||||||||||||||||||||
| 443 | Args : none | ||||||||||||||||||||||||||||
| 444 | |||||||||||||||||||||||||||||
| 445 | =cut | ||||||||||||||||||||||||||||
| 446 | |||||||||||||||||||||||||||||
| 447 | 0 | ▶ | sub get_support_values { | ||||||||||||||||||||||||||
|
Subroutine
get_support_values: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||
| 448 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 449 | 0 | my $nodes = $self->get_nodes(); | |||||||||||||||||||||||||||
| 450 | 0 | my %bootstraps; | |||||||||||||||||||||||||||
| 451 | 0 | for my $node ( @{$nodes} ) { | |||||||||||||||||||||||||||
| 452 | 0 | my $boot = $node->get_support_value(); | |||||||||||||||||||||||||||
| 453 | 0 | ▶ | $bootstraps{ $node->get_name() } = $boot if $boot; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 454 | } | ||||||||||||||||||||||||||||
| 455 | 0 | return \%bootstraps; | |||||||||||||||||||||||||||
| 456 | } | ||||||||||||||||||||||||||||
| 457 | |||||||||||||||||||||||||||||
| 458 | =begin comment | ||||||||||||||||||||||||||||
| 459 | |||||||||||||||||||||||||||||
| 460 | Title : _set_xcoord | ||||||||||||||||||||||||||||
| 461 | Usage : $tree->_set_xcoord($xpos,$maxx); | ||||||||||||||||||||||||||||
| 462 | Function: Determines x coords of OTUs and internal nodes | ||||||||||||||||||||||||||||
| 463 | Returns : none | ||||||||||||||||||||||||||||
| 464 | Args : maximum x (number) | ||||||||||||||||||||||||||||
| 465 | |||||||||||||||||||||||||||||
| 466 | =end comment | ||||||||||||||||||||||||||||
| 467 | |||||||||||||||||||||||||||||
| 468 | =cut | ||||||||||||||||||||||||||||
| 469 | |||||||||||||||||||||||||||||
| 470 | 0 | ▶ | sub _set_xcoord { | ||||||||||||||||||||||||||
|
Subroutine
_set_xcoord: not called CC=10 SCAR=47.0
| |||||||||||||||||||||||||||||
| 471 | 0 | my ( $self, $maxx, $cladogramMethod ) = @_; | |||||||||||||||||||||||||||
| 472 | 0 | my $xcoord = | |||||||||||||||||||||||||||
| 473 | [ { 'node' => '', 'xcoord' => '' }, { 'node' => '', 'xcoord' => '' } ]; | ||||||||||||||||||||||||||||
| 474 | 0 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 475 | 0 | my @nodes = @{ $self->get_nodes() }; | |||||||||||||||||||||||||||
| 476 | 0 | ▶ | if ( $self->is_cladogram() || $cladogramMethod ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$self->is_cladogram or $cladogramMethod
MC/DC0%0/2
$self->is_cladogram or $cladogramMethod
$self->is_cladogram
$cladogramMethod
Truth table0%0/3
A or B
A= $self->is_cladogramB= $cladogramMethod
| |||||||||||||||||||||||||||||
| 477 | 0 | ▶ | $cladogramMethod = 'normal' unless $cladogramMethod; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 478 | 0 | my $maxdepth = $self->max_depth(); | |||||||||||||||||||||||||||
| 479 | 0 | my $unit = $maxx / $maxdepth; | |||||||||||||||||||||||||||
| 480 | 0 | my @xcoord; | |||||||||||||||||||||||||||
| 481 | 0 | ▶ | if ( $cladogramMethod eq "accelerated" ) { | ||||||||||||||||||||||||||
|
Branch: 2 branches
| |||||||||||||||||||||||||||||
| 482 | 0 | for my $node (@nodes) { | |||||||||||||||||||||||||||
| 483 | 0 | ▶ | if ( $node->is_otu() ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 484 | 0 | $node->_set_xcoord( $maxdepth * $unit ); | |||||||||||||||||||||||||||
| 485 | } | ||||||||||||||||||||||||||||
| 486 | else { | ||||||||||||||||||||||||||||
| 487 | 0 | $node->_set_xcoord( $node->get_depth() * $unit ); | |||||||||||||||||||||||||||
| 488 | } | ||||||||||||||||||||||||||||
| 489 | } | ||||||||||||||||||||||||||||
| 490 | } | ||||||||||||||||||||||||||||
| 491 | elsif ( $cladogramMethod eq "normal" ) { | ||||||||||||||||||||||||||||
| 492 | 0 | my %depth = %{ $self->get_depth() }; | |||||||||||||||||||||||||||
| 493 | 0 | for my $node (@nodes) { | |||||||||||||||||||||||||||
| 494 | 0 | $node->_set_xcoord( $node->get_depth() * $unit ); | |||||||||||||||||||||||||||
| 495 | } | ||||||||||||||||||||||||||||
| 496 | } | ||||||||||||||||||||||||||||
| 497 | } | ||||||||||||||||||||||||||||
| 498 | else { | ||||||||||||||||||||||||||||
| 499 | 0 | for my $node (@nodes) { | |||||||||||||||||||||||||||
| 500 | 0 | $node->_set_xcoord( $root->get_distance($node) ); | |||||||||||||||||||||||||||
| 501 | } | ||||||||||||||||||||||||||||
| 502 | } | ||||||||||||||||||||||||||||
| 503 | } | ||||||||||||||||||||||||||||
| 504 | |||||||||||||||||||||||||||||
| 505 | =begin comment | ||||||||||||||||||||||||||||
| 506 | |||||||||||||||||||||||||||||
| 507 | Title : _set_ycoord | ||||||||||||||||||||||||||||
| 508 | Usage : $tree->_set_ycoord($ypos,$spacing); | ||||||||||||||||||||||||||||
| 509 | Function: Determines y coords of OTUs and internal nodes | ||||||||||||||||||||||||||||
| 510 | Returns : none | ||||||||||||||||||||||||||||
| 511 | Args : initial y position (number), space between OTUs (number) | ||||||||||||||||||||||||||||
| 512 | |||||||||||||||||||||||||||||
| 513 | =end comment | ||||||||||||||||||||||||||||
| 514 | |||||||||||||||||||||||||||||
| 515 | =cut | ||||||||||||||||||||||||||||
| 516 | |||||||||||||||||||||||||||||
| 517 | 0 | ▶ | sub _set_ycoord { | ||||||||||||||||||||||||||
|
Subroutine
_set_ycoord: not called CC=1 SCAR=6.9
| |||||||||||||||||||||||||||||
| 518 | 0 | my ( $self, $ypos, $spacing ) = @_; | |||||||||||||||||||||||||||
| 519 | 0 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 520 | 0 | $root->_assign_otu_ycoord( \$ypos, \$spacing ); | |||||||||||||||||||||||||||
| 521 | 0 | $root->_assign_inode_ycoord(); | |||||||||||||||||||||||||||
| 522 | } | ||||||||||||||||||||||||||||
| 523 | |||||||||||||||||||||||||||||
| 524 | =head2 set_depth | ||||||||||||||||||||||||||||
| 525 | |||||||||||||||||||||||||||||
| 526 | Title : set_depth | ||||||||||||||||||||||||||||
| 527 | Usage : $tree->set_depth(); | ||||||||||||||||||||||||||||
| 528 | Function: Sets depth of root node | ||||||||||||||||||||||||||||
| 529 | Returns : none | ||||||||||||||||||||||||||||
| 530 | Args : none | ||||||||||||||||||||||||||||
| 531 | |||||||||||||||||||||||||||||
| 532 | =cut | ||||||||||||||||||||||||||||
| 533 | |||||||||||||||||||||||||||||
| 534 | 82 | ▶ | sub set_depth { | ||||||||||||||||||||||||||
|
Subroutine
set_depth: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 535 | 82 | my $self = shift; | |||||||||||||||||||||||||||
| 536 | 82 | my $root = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 537 | 82 | $root->set_depth(0); | |||||||||||||||||||||||||||
| 538 | } | ||||||||||||||||||||||||||||
| 539 | |||||||||||||||||||||||||||||
| 540 | =head2 get_depth | ||||||||||||||||||||||||||||
| 541 | |||||||||||||||||||||||||||||
| 542 | Title : get_depth | ||||||||||||||||||||||||||||
| 543 | Usage : %depth=%{$tree->get_depth()}; | ||||||||||||||||||||||||||||
| 544 | Function: Get depth in tree of all OTUs and internal nodes | ||||||||||||||||||||||||||||
| 545 | Returns : reference to hash with keys = node names and values = depth | ||||||||||||||||||||||||||||
| 546 | Args : none | ||||||||||||||||||||||||||||
| 547 | |||||||||||||||||||||||||||||
| 548 | =cut | ||||||||||||||||||||||||||||
| 549 | |||||||||||||||||||||||||||||
| 550 | 6 | ▶ | sub get_depth { | ||||||||||||||||||||||||||
|
Subroutine
get_depth: called CC=4 SCAR=14.0
Pod
documented
| |||||||||||||||||||||||||||||
| 551 | 6 | my $self = shift; | |||||||||||||||||||||||||||
| 552 | 6 | my $nodes = $self->get_nodes(); | |||||||||||||||||||||||||||
| 553 | 6 | my %depth; | |||||||||||||||||||||||||||
| 554 | 6 | for my $node ( @{$nodes} ) { | |||||||||||||||||||||||||||
| 555 | 54 | my $d = $node->get_depth(); | |||||||||||||||||||||||||||
| 556 | 54 | ▶ | $depth{ $node->get_name() } = $d if ( $d || ( $d == 0 ) ); | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
$d or $d == 0
MC/DC0%0/2
$d or $d == 0
$d
$d == 0
Truth table66%2/3
A or B
A= $dB= $d == 0
| |||||||||||||||||||||||||||||
| 557 | } | ||||||||||||||||||||||||||||
| 558 | 6 | return \%depth; | |||||||||||||||||||||||||||
| 559 | } | ||||||||||||||||||||||||||||
| 560 | |||||||||||||||||||||||||||||
| 561 | =head2 max_depth | ||||||||||||||||||||||||||||
| 562 | |||||||||||||||||||||||||||||
| 563 | Title : max_depth | ||||||||||||||||||||||||||||
| 564 | Usage : $maxdepth=%{$tree->max_depth()}; | ||||||||||||||||||||||||||||
| 565 | Function: Get maximum depth of tree | ||||||||||||||||||||||||||||
| 566 | Returns : integer indicating maximum depth | ||||||||||||||||||||||||||||
| 567 | Args : none | ||||||||||||||||||||||||||||
| 568 | |||||||||||||||||||||||||||||
| 569 | =cut | ||||||||||||||||||||||||||||
| 570 | |||||||||||||||||||||||||||||
| 571 | 2 | ▶ | sub max_depth { | ||||||||||||||||||||||||||
|
Subroutine
max_depth: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 572 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 573 | 2 | my %depth = %{ $self->get_depth() }; | |||||||||||||||||||||||||||
| 574 | 2 | my @sorted = sort { $a <=> $b } values %depth; | |||||||||||||||||||||||||||
| 575 | 2 | return ( pop @sorted ); | |||||||||||||||||||||||||||
| 576 | } | ||||||||||||||||||||||||||||
| 577 | |||||||||||||||||||||||||||||
| 578 | =head2 find | ||||||||||||||||||||||||||||
| 579 | |||||||||||||||||||||||||||||
| 580 | Title : find | ||||||||||||||||||||||||||||
| 581 | Usage : $node = $tree->find($name); | ||||||||||||||||||||||||||||
| 582 | Function: Finds the first occurrence of a node called 'name' in the tree | ||||||||||||||||||||||||||||
| 583 | Returns : Bio::NEXUS::Node object | ||||||||||||||||||||||||||||
| 584 | Args : name (string) | ||||||||||||||||||||||||||||
| 585 | |||||||||||||||||||||||||||||
| 586 | =cut | ||||||||||||||||||||||||||||
| 587 | |||||||||||||||||||||||||||||
| 588 | 31 | ▶ | sub find { | ||||||||||||||||||||||||||
|
Subroutine
find: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 589 | 31 | my ( $self, $name ) = @_; | |||||||||||||||||||||||||||
| 590 | 31 | my $rootnode = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 591 | 31 | my $node = $rootnode->find($name); | |||||||||||||||||||||||||||
| 592 | 31 | return $node; | |||||||||||||||||||||||||||
| 593 | } | ||||||||||||||||||||||||||||
| 594 | |||||||||||||||||||||||||||||
| 595 | =head2 find_all | ||||||||||||||||||||||||||||
| 596 | |||||||||||||||||||||||||||||
| 597 | Title : find_all | ||||||||||||||||||||||||||||
| 598 | Usage : @nodes = @{ $tree->find_all($name) }; | ||||||||||||||||||||||||||||
| 599 | Function: find all occurrences of nodes called 'name' in the tree | ||||||||||||||||||||||||||||
| 600 | Returns : Bio::NEXUS::Node objects | ||||||||||||||||||||||||||||
| 601 | Args : name (string) | ||||||||||||||||||||||||||||
| 602 | |||||||||||||||||||||||||||||
| 603 | =cut | ||||||||||||||||||||||||||||
| 604 | |||||||||||||||||||||||||||||
| 605 | 0 | ▶ | sub find_all { | ||||||||||||||||||||||||||
|
Subroutine
find_all: not called CC=3 SCAR=24.8
Pod
documented
| |||||||||||||||||||||||||||||
| 606 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 607 | 0 | my @nodes; | |||||||||||||||||||||||||||
| 608 | 0 | my @all_nodes = @{ $self->get_nodes() }; | |||||||||||||||||||||||||||
| 609 | 0 | my $name = shift; | |||||||||||||||||||||||||||
| 610 | 0 | for my $node (@all_nodes) { | |||||||||||||||||||||||||||
| 611 | 0 | ▶ | if ( $name eq $node->get_name() ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 612 | 0 | push( @nodes, $node ); | |||||||||||||||||||||||||||
| 613 | } | ||||||||||||||||||||||||||||
| 614 | } | ||||||||||||||||||||||||||||
| 615 | 0 | return \@nodes; | |||||||||||||||||||||||||||
| 616 | } | ||||||||||||||||||||||||||||
| 617 | |||||||||||||||||||||||||||||
| 618 | =head2 prune | ||||||||||||||||||||||||||||
| 619 | |||||||||||||||||||||||||||||
| 620 | Name : prune | ||||||||||||||||||||||||||||
| 621 | Usage : $tree->prune($OTUlist); | ||||||||||||||||||||||||||||
| 622 | Function: Removes everything from the tree except for OTUs specified in $OTUlist | ||||||||||||||||||||||||||||
| 623 | Returns : none | ||||||||||||||||||||||||||||
| 624 | Args : list of OTUs (string) | ||||||||||||||||||||||||||||
| 625 | |||||||||||||||||||||||||||||
| 626 | =cut | ||||||||||||||||||||||||||||
| 627 | |||||||||||||||||||||||||||||
| 628 | 1 | ▶ | sub prune { | ||||||||||||||||||||||||||
|
Subroutine
prune: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 629 | 1 | my ( $self, $OTUlist ) = @_; | |||||||||||||||||||||||||||
| 630 | 1 | $OTUlist = ' ' . $OTUlist . ' '; | |||||||||||||||||||||||||||
| 631 | 1 | my $rootnode = $self->get_rootnode(); | |||||||||||||||||||||||||||
| 632 | 1 | $rootnode->prune($OTUlist); | |||||||||||||||||||||||||||
| 633 | } | ||||||||||||||||||||||||||||
| 634 | |||||||||||||||||||||||||||||
| 635 | =head2 equals | ||||||||||||||||||||||||||||
| 636 | |||||||||||||||||||||||||||||
| 637 | Name : equals | ||||||||||||||||||||||||||||
| 638 | Usage : $tree->equals($another_tree); | ||||||||||||||||||||||||||||
| 639 | Function: compare if two trees are equivalent in topology | ||||||||||||||||||||||||||||
| 640 | Returns : 1 if equal or 0 if not | ||||||||||||||||||||||||||||
| 641 | Args : another Bio::NEXUS::Tree object | ||||||||||||||||||||||||||||
| 642 | |||||||||||||||||||||||||||||
| 643 | =cut | ||||||||||||||||||||||||||||
| 644 | |||||||||||||||||||||||||||||
| 645 | 25 | ▶ | sub equals { | ||||||||||||||||||||||||||
|
Subroutine
equals: called CC=2 SCAR=7.6
Pod
documented
| |||||||||||||||||||||||||||||
| 646 | 25 | my ( $self, $tree ) = @_; | |||||||||||||||||||||||||||
| 647 | |||||||||||||||||||||||||||||
| 648 | 0 | ▶ | if ( $self->get_name() ne $tree->get_name() ) { return 0; } | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 649 | 25 | return $self->get_rootnode()->equals( $tree->get_rootnode() ); | |||||||||||||||||||||||||||
| 650 | } | ||||||||||||||||||||||||||||
| 651 | |||||||||||||||||||||||||||||
| 652 | 0 | ▶ | sub _equals_test { | ||||||||||||||||||||||||||
|
Subroutine
_equals_test: not called CC=2 SCAR=17.9
| |||||||||||||||||||||||||||||
| 653 | 0 | my ( $self, $tree ) = @_; | |||||||||||||||||||||||||||
| 654 | |||||||||||||||||||||||||||||
| 655 | 0 | ▶ | if ( $self->get_name() ne $tree->get_name() ) { return 0; } | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 656 | 0 | return $self->get_rootnode()->_equals_test( $tree->get_rootnode() ); | |||||||||||||||||||||||||||
| 657 | } | ||||||||||||||||||||||||||||
| 658 | |||||||||||||||||||||||||||||
| 659 | =head2 reroot | ||||||||||||||||||||||||||||
| 660 | |||||||||||||||||||||||||||||
| 661 | Name : reroot | ||||||||||||||||||||||||||||
| 662 | Usage : $tree = $tree->reroot($outgroup_name); | ||||||||||||||||||||||||||||
| 663 | Function: re-root a tree with a node as outgroup | ||||||||||||||||||||||||||||
| 664 | Returns : | ||||||||||||||||||||||||||||
| 665 | Args : the node name to be used as new outgroup | ||||||||||||||||||||||||||||
| 666 | |||||||||||||||||||||||||||||
| 667 | =cut | ||||||||||||||||||||||||||||
| 668 | |||||||||||||||||||||||||||||
| 669 | 0 | ▶ | sub reroot { | ||||||||||||||||||||||||||
|
Subroutine
reroot: not called CC=4 SCAR=30.0
Pod
documented
| |||||||||||||||||||||||||||||
| 670 | 0 | my ( $self, $outgroup_name, $dist_back_to_newroot ) = @_; | |||||||||||||||||||||||||||
| 671 | 0 | ▶ | if ( not defined $outgroup_name ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 672 | 0 | Bio::NEXUS::Util::Exceptions::BadArgs->throw( | |||||||||||||||||||||||||||
| 673 | 'error' => 'An outgroup name must be supplied as an argument in order to reroot' | ||||||||||||||||||||||||||||
| 674 | ); | ||||||||||||||||||||||||||||
| 675 | } | ||||||||||||||||||||||||||||
| 676 | |||||||||||||||||||||||||||||
| 677 | 0 | my $tree = $self->clone(); | |||||||||||||||||||||||||||
| 678 | |||||||||||||||||||||||||||||
| 679 | # find the current root of the tree | ||||||||||||||||||||||||||||
| 680 | 0 | my $oldroot = $tree->get_rootnode(); | |||||||||||||||||||||||||||
| 681 | |||||||||||||||||||||||||||||
| 682 | # rename it, since nexplot relies on all nodes having unique names | ||||||||||||||||||||||||||||
| 683 | 0 | &_rename_oldroot( $tree, $oldroot ); | |||||||||||||||||||||||||||
| 684 | |||||||||||||||||||||||||||||
| 685 | # get the outgroup node | ||||||||||||||||||||||||||||
| 686 | 0 | my $outgroup = $tree->find($outgroup_name); | |||||||||||||||||||||||||||
| 687 | |||||||||||||||||||||||||||||
| 688 | # create & name a new node that will become the new root | ||||||||||||||||||||||||||||
| 689 | 0 | my $newroot = new Bio::NEXUS::Node(); | |||||||||||||||||||||||||||
| 690 | |||||||||||||||||||||||||||||
| 691 | 0 | ▶ | if ( $dist_back_to_newroot | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$dist_back_to_newroot and $dist_back_to_newroot == $outgroup->get_length
MC/DC0%0/2
$dist_back_to_newroot and $dist_back_to_newroot == $outgroup->get_length
$dist_back_to_newroot
$dist_back_to_newroot == $outgroup->get_length
Truth table0%0/3
A and B
A= $dist_back_to_newrootB= $dist_back_to_newroot == $outgroup->get_length
| |||||||||||||||||||||||||||||
| 692 | && $dist_back_to_newroot == $outgroup->get_length() ) | ||||||||||||||||||||||||||||
| 693 | { | ||||||||||||||||||||||||||||
| 694 | 0 | $newroot = $outgroup->get_parent(); | |||||||||||||||||||||||||||
| 695 | 0 | $outgroup->set_length($dist_back_to_newroot); | |||||||||||||||||||||||||||
| 696 | 0 | $newroot->get_parent()->_rearrange($newroot); | |||||||||||||||||||||||||||
| 697 | } | ||||||||||||||||||||||||||||
| 698 | else { | ||||||||||||||||||||||||||||
| 699 | |||||||||||||||||||||||||||||
| 700 | # find the node that will (temporarily) become the newroot's parent | ||||||||||||||||||||||||||||
| 701 | 0 | my $outgroup_old_parent = $outgroup->get_parent(); | |||||||||||||||||||||||||||
| 702 | |||||||||||||||||||||||||||||
| 703 | # get the siblings of the outgroup | ||||||||||||||||||||||||||||
| 704 | 0 | my $newroot_siblings = $outgroup->get_siblings(); | |||||||||||||||||||||||||||
| 705 | |||||||||||||||||||||||||||||
| 706 | # get the correct branch lengths for newroot and outgroup | ||||||||||||||||||||||||||||
| 707 | 0 | &_position_newroot( $outgroup, $newroot, $dist_back_to_newroot ); | |||||||||||||||||||||||||||
| 708 | |||||||||||||||||||||||||||||
| 709 | # make outgroup the newroot's child and newroot the outgroup's parent | ||||||||||||||||||||||||||||
| 710 | 0 | $newroot->adopt( $outgroup, 1 ); | |||||||||||||||||||||||||||
| 711 | |||||||||||||||||||||||||||||
| 712 | # remove the outgroup from the old parent's children | ||||||||||||||||||||||||||||
| 713 | 0 | $outgroup_old_parent->set_children($newroot_siblings); | |||||||||||||||||||||||||||
| 714 | |||||||||||||||||||||||||||||
| 715 | # add the newroot as a child | ||||||||||||||||||||||||||||
| 716 | 0 | $outgroup_old_parent->adopt( $newroot, 0 ); | |||||||||||||||||||||||||||
| 717 | |||||||||||||||||||||||||||||
| 718 | # recursively reverse the parent-child relationships between newroot and oldroot | ||||||||||||||||||||||||||||
| 719 | 0 | $outgroup_old_parent->_rearrange($newroot); | |||||||||||||||||||||||||||
| 720 | } | ||||||||||||||||||||||||||||
| 721 | |||||||||||||||||||||||||||||
| 722 | # set newroot's values to make it root | ||||||||||||||||||||||||||||
| 723 | 0 | $newroot->set_name('root'); | |||||||||||||||||||||||||||
| 724 | 0 | $newroot->set_parent_node(); | |||||||||||||||||||||||||||
| 725 | 0 | $newroot->set_support_value(); | |||||||||||||||||||||||||||
| 726 | 0 | $newroot->set_length(); | |||||||||||||||||||||||||||
| 727 | 0 | $newroot->set_depth(0); | |||||||||||||||||||||||||||
| 728 | 0 | $tree->set_rootnode($newroot); | |||||||||||||||||||||||||||
| 729 | |||||||||||||||||||||||||||||
| 730 | # remove oldroot if the tree was bifurcating | ||||||||||||||||||||||||||||
| 731 | 0 | &_remove_oldroot_if_superfluous($oldroot); | |||||||||||||||||||||||||||
| 732 | |||||||||||||||||||||||||||||
| 733 | 0 | return $tree; | |||||||||||||||||||||||||||
| 734 | } | ||||||||||||||||||||||||||||
| 735 | |||||||||||||||||||||||||||||
| 736 | 0 | ▶ | sub _rename_oldroot { | ||||||||||||||||||||||||||
|
Subroutine
_rename_oldroot: not called CC=3 SCAR=24.8
| |||||||||||||||||||||||||||||
| 737 | 0 | my ( $tree, $oldroot ) = @_; | |||||||||||||||||||||||||||
| 738 | 0 | my $i = 0; | |||||||||||||||||||||||||||
| 739 | 0 | my $renamed_oldroot = 0; | |||||||||||||||||||||||||||
| 740 | 0 | my $oldroot_name = 'oldroot'; | |||||||||||||||||||||||||||
| 741 | 0 | ▶ | while ( $renamed_oldroot == 0 ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 742 | 0 | ▶ | if ( !$tree->find("$oldroot_name") ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 743 | 0 | $oldroot->set_name("$oldroot_name"); | |||||||||||||||||||||||||||
| 744 | 0 | $renamed_oldroot = 1; | |||||||||||||||||||||||||||
| 745 | } | ||||||||||||||||||||||||||||
| 746 | else { | ||||||||||||||||||||||||||||
| 747 | 0 | $oldroot_name = "oldroot" . "$i"; | |||||||||||||||||||||||||||
| 748 | 0 | $i++; | |||||||||||||||||||||||||||
| 749 | } | ||||||||||||||||||||||||||||
| 750 | } | ||||||||||||||||||||||||||||
| 751 | } | ||||||||||||||||||||||||||||
| 752 | |||||||||||||||||||||||||||||
| 753 | 0 | ▶ | sub _position_newroot { | ||||||||||||||||||||||||||
|
Subroutine
_position_newroot: not called CC=6 SCAR=37.4
| |||||||||||||||||||||||||||||
| 754 | 0 | my ( $outgroup, $newroot, $dist_back_to_newroot ) = @_; | |||||||||||||||||||||||||||
| 755 | 0 | ▶ | if ( $outgroup->get_length() ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 756 | 0 | my $outgroup_length = $outgroup->get_length(); | |||||||||||||||||||||||||||
| 757 | 0 | ▶ | if ($dist_back_to_newroot) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 758 | 0 | ▶ | if ( $dist_back_to_newroot < $outgroup_length | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
$dist_back_to_newroot < $outgroup_length and $dist_back_to_newroot > 0
MC/DC0%0/2
$dist_back_to_newroot < $outgroup_length and $dist_back_to_newroot > 0
$dist_back_to_newroot < $outgroup_length
$dist_back_to_newroot > 0
Truth table0%0/3
A and B
A= $dist_back_to_newroot < $outgroup_lengthB= $dist_back_to_newroot > 0
| |||||||||||||||||||||||||||||
| 759 | && $dist_back_to_newroot > 0 ) | ||||||||||||||||||||||||||||
| 760 | { | ||||||||||||||||||||||||||||
| 761 | ## $dist_back_to_newroot should already be negative | ||||||||||||||||||||||||||||
| 762 | 0 | $newroot->set_length( | |||||||||||||||||||||||||||
| 763 | $outgroup_length - $dist_back_to_newroot ); | ||||||||||||||||||||||||||||
| 764 | 0 | $outgroup->set_length($dist_back_to_newroot); | |||||||||||||||||||||||||||
| 765 | } | ||||||||||||||||||||||||||||
| 766 | else { | ||||||||||||||||||||||||||||
| 767 | 0 | Bio::NEXUS::Util::Exceptions::BadNumber->throw( | |||||||||||||||||||||||||||
| 768 | 'error' => "Branch length error: The new root's position\n" | ||||||||||||||||||||||||||||
| 769 | . "up the tree from the outgroup must be a positive\n" | ||||||||||||||||||||||||||||
| 770 | . "number less than or equal to the outgroup's branch length.\n" | ||||||||||||||||||||||||||||
| 771 | ); | ||||||||||||||||||||||||||||
| 772 | } | ||||||||||||||||||||||||||||
| 773 | } | ||||||||||||||||||||||||||||
| 774 | else { | ||||||||||||||||||||||||||||
| 775 | 0 | $newroot->set_length( $outgroup_length / 2 ); | |||||||||||||||||||||||||||
| 776 | 0 | $outgroup->set_length( $outgroup_length / 2 ); | |||||||||||||||||||||||||||
| 777 | } | ||||||||||||||||||||||||||||
| 778 | } | ||||||||||||||||||||||||||||
| 779 | else { | ||||||||||||||||||||||||||||
| 780 | 0 | ▶ | if ($dist_back_to_newroot) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 781 | 0 | Bio::NEXUS::Util::Exceptions::BadArgs->throw( | |||||||||||||||||||||||||||
| 782 | 'error' => "You provided a position for the new root on the\n" | ||||||||||||||||||||||||||||
| 783 | . "outgroup's branch length, but the outgroup does\n" | ||||||||||||||||||||||||||||
| 784 | . "not have a branch length.\n" | ||||||||||||||||||||||||||||
| 785 | ); | ||||||||||||||||||||||||||||
| 786 | } | ||||||||||||||||||||||||||||
| 787 | } | ||||||||||||||||||||||||||||
| 788 | } | ||||||||||||||||||||||||||||
| 789 | |||||||||||||||||||||||||||||
| 790 | 0 | ▶ | sub _remove_oldroot_if_superfluous { | ||||||||||||||||||||||||||
|
Subroutine
_remove_oldroot_if_superfluous: not called CC=4 SCAR=30.0
| |||||||||||||||||||||||||||||
| 791 | 0 | my ($oldroot) = @_; | |||||||||||||||||||||||||||
| 792 | 0 | ▶ | if ( @{ $oldroot->get_children() } == 1 ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 793 | 0 | my $oldroot_child = ${ $oldroot->get_children() }[0]; | |||||||||||||||||||||||||||
| 794 | 0 | ▶ | if ( defined $oldroot->get_length() | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition0%0/3
defined $oldroot->get_length or defined $oldroot_child->get_length
MC/DC0%0/2
defined $oldroot->get_length or defined $oldroot_child->get_length
defined $oldroot->get_length
defined $oldroot_child->get_length
Truth table0%0/3
A or B
A= defined $oldroot->get_lengthB= defined $oldroot_child->get_length
| |||||||||||||||||||||||||||||
| 795 | || defined $oldroot_child->get_length() ) | ||||||||||||||||||||||||||||
| 796 | { | ||||||||||||||||||||||||||||
| 797 | 0 | $oldroot_child->set_length( | |||||||||||||||||||||||||||
| 798 | $oldroot->get_length() + $oldroot_child->get_length() ); | ||||||||||||||||||||||||||||
| 799 | } | ||||||||||||||||||||||||||||
| 800 | 0 | my $oldroot_parent = $oldroot->get_parent(); | |||||||||||||||||||||||||||
| 801 | 0 | $oldroot_parent->set_children( $oldroot->get_siblings() ); | |||||||||||||||||||||||||||
| 802 | 0 | $oldroot_parent->adopt( $oldroot_child, 0 ); | |||||||||||||||||||||||||||
| 803 | } | ||||||||||||||||||||||||||||
| 804 | } | ||||||||||||||||||||||||||||
| 805 | |||||||||||||||||||||||||||||
| 806 | =head2 select_subtree | ||||||||||||||||||||||||||||
| 807 | |||||||||||||||||||||||||||||
| 808 | Name : select_subtree | ||||||||||||||||||||||||||||
| 809 | Usage : $new_tree_obj = $self->select_subtree($node_name); | ||||||||||||||||||||||||||||
| 810 | Function: selects the subtree (the given node and all its children) from the tree object. | ||||||||||||||||||||||||||||
| 811 | Returns : new Bio::NEXUS::Tree object | ||||||||||||||||||||||||||||
| 812 | Args : Node name | ||||||||||||||||||||||||||||
| 813 | |||||||||||||||||||||||||||||
| 814 | =cut | ||||||||||||||||||||||||||||
| 815 | |||||||||||||||||||||||||||||
| 816 | 2 | ▶ | sub select_subtree { | ||||||||||||||||||||||||||
|
Subroutine
select_subtree: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 817 | 2 | my ( $self, $nodename ) = @_; | |||||||||||||||||||||||||||
| 818 | 2 | my $newroot = $self->find($nodename); | |||||||||||||||||||||||||||
| 819 | 2 | my $treename = $self->get_name(); | |||||||||||||||||||||||||||
| 820 | 2 | ▶ | if ( not $newroot ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 821 | 1 | Bio::NEXUS::Util::Exceptions::BadArgs->throw( | |||||||||||||||||||||||||||
| 822 | 'error' => "Node $nodename not found in $treename" | ||||||||||||||||||||||||||||
| 823 | ); | ||||||||||||||||||||||||||||
| 824 | } | ||||||||||||||||||||||||||||
| 825 | 1 | $newroot = $newroot->clone(); # need to clone subtree | |||||||||||||||||||||||||||
| 826 | 1 | $newroot->set_parent_node(); # make it as root | |||||||||||||||||||||||||||
| 827 | 1 | $newroot->set_support_value(); | |||||||||||||||||||||||||||
| 828 | 1 | $newroot->set_length(); | |||||||||||||||||||||||||||
| 829 | 1 | my $tree = new Bio::NEXUS::Tree(); | |||||||||||||||||||||||||||
| 830 | 1 | $tree->set_name( $self->get_name() ); | |||||||||||||||||||||||||||
| 831 | 1 | $tree->set_rootnode($newroot); | |||||||||||||||||||||||||||
| 832 | 1 | return $tree; | |||||||||||||||||||||||||||
| 833 | } | ||||||||||||||||||||||||||||
| 834 | |||||||||||||||||||||||||||||
| 835 | =head2 exclude_subtree | ||||||||||||||||||||||||||||
| 836 | |||||||||||||||||||||||||||||
| 837 | Name : exclude_subtree | ||||||||||||||||||||||||||||
| 838 | Usage : $new_tree_obj = $self->exclude_subtree($node_name); | ||||||||||||||||||||||||||||
| 839 | Function: removes the given node and all its children from the tree object. | ||||||||||||||||||||||||||||
| 840 | Returns : new Bio::NEXUS::Tree object | ||||||||||||||||||||||||||||
| 841 | Args : Node name | ||||||||||||||||||||||||||||
| 842 | |||||||||||||||||||||||||||||
| 843 | =cut | ||||||||||||||||||||||||||||
| 844 | |||||||||||||||||||||||||||||
| 845 | 0 | ▶ | sub exclude_subtree { | ||||||||||||||||||||||||||
|
Subroutine
exclude_subtree: not called CC=5 SCAR=34.0
Pod
documented
| |||||||||||||||||||||||||||||
| 846 | 0 | my ( $self, $nodename ) = @_; | |||||||||||||||||||||||||||
| 847 | 0 | my $treename = $self->get_name(); | |||||||||||||||||||||||||||
| 848 | 0 | my $tree = $self->clone(); | |||||||||||||||||||||||||||
| 849 | 0 | my $removenode = $tree->find($nodename); | |||||||||||||||||||||||||||
| 850 | |||||||||||||||||||||||||||||
| 851 | 0 | ▶ | if ( not $removenode ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 852 | 0 | Bio::NEXUS::Util::Exceptions::BadArgs->throw( | |||||||||||||||||||||||||||
| 853 | 'error' => "Node $nodename not found in $treename" | ||||||||||||||||||||||||||||
| 854 | ); | ||||||||||||||||||||||||||||
| 855 | } | ||||||||||||||||||||||||||||
| 856 | |||||||||||||||||||||||||||||
| 857 | 0 | my $parent = $removenode->get_parent(); | |||||||||||||||||||||||||||
| 858 | 0 | my @children = @{ $parent->get_children() }; | |||||||||||||||||||||||||||
| 859 | 0 | $parent->set_children(); | |||||||||||||||||||||||||||
| 860 | 0 | for my $child (@children) { | |||||||||||||||||||||||||||
| 861 | 0 | ▶ | if ( $child->get_name() ne $removenode->get_name() ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 862 | 0 | $parent->add_child($child); | |||||||||||||||||||||||||||
| 863 | } | ||||||||||||||||||||||||||||
| 864 | } | ||||||||||||||||||||||||||||
| 865 | 0 | ▶ | if ( @{ $parent->get_children() } == 1 ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 866 | 0 | my $sibling = $parent->get_children()->[0]; | |||||||||||||||||||||||||||
| 867 | 0 | $parent->combine($sibling); | |||||||||||||||||||||||||||
| 868 | } | ||||||||||||||||||||||||||||
| 869 | |||||||||||||||||||||||||||||
| 870 | 0 | return $tree; | |||||||||||||||||||||||||||
| 871 | } | ||||||||||||||||||||||||||||
| 872 | |||||||||||||||||||||||||||||
| 873 | =head2 get_mrca_of_otus | ||||||||||||||||||||||||||||
| 874 | |||||||||||||||||||||||||||||
| 875 | Name : get_mrca_of_otus | ||||||||||||||||||||||||||||
| 876 | Usage : $node = $self->get_mrca_of_otus($otus); | ||||||||||||||||||||||||||||
| 877 | Function: gets the most recent common ancestor for the input $otus | ||||||||||||||||||||||||||||
| 878 | Returns : Bio::NEXUS::Node object | ||||||||||||||||||||||||||||
| 879 | Args : $otus : Array reference of the OTUs | ||||||||||||||||||||||||||||
| 880 | |||||||||||||||||||||||||||||
| 881 | =cut | ||||||||||||||||||||||||||||
| 882 | |||||||||||||||||||||||||||||
| 883 | 0 | ▶ | sub get_mrca_of_otus { | ||||||||||||||||||||||||||
|
Subroutine
get_mrca_of_otus: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 884 | 0 | my ( $self, $otus) = @_; | |||||||||||||||||||||||||||
| 885 | 0 | my $root_node = $self->get_rootnode; | |||||||||||||||||||||||||||
| 886 | 0 | return $root_node->get_mrca_of_otus($otus); | |||||||||||||||||||||||||||
| 887 | } | ||||||||||||||||||||||||||||
| 888 | |||||||||||||||||||||||||||||
| 889 | 85 | ▶ | sub AUTOLOAD { | ||||||||||||||||||||||||||
|
Subroutine
AUTOLOAD: called CC=3 SCAR=21.3
| |||||||||||||||||||||||||||||
| 890 | 85 | ▶ | return if $AUTOLOAD =~ /DESTROY$/; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 891 | 0 | my $package_name = __PACKAGE__ . '::'; | |||||||||||||||||||||||||||
| 892 | |||||||||||||||||||||||||||||
| 893 | # The following methods are deprecated and are temporarily supported | ||||||||||||||||||||||||||||
| 894 | # via a warning and a redirection | ||||||||||||||||||||||||||||
| 895 | 0 | my %synonym_for = ( | |||||||||||||||||||||||||||
| 896 | "${package_name}node_list" => "${package_name}get_nodes", | ||||||||||||||||||||||||||||
| 897 | "${package_name}otu_list" => "${package_name}get_node_names", | ||||||||||||||||||||||||||||
| 898 | "${package_name}set_xcoord" => "${package_name}_set_xcoord", | ||||||||||||||||||||||||||||
| 899 | "${package_name}set_ycoord" => "${package_name}_set_ycoord", | ||||||||||||||||||||||||||||
| 900 | "${package_name}name" => "${package_name}get_name", | ||||||||||||||||||||||||||||
| 901 | "${package_name}set_tree" => "${package_name}_parse_newick", | ||||||||||||||||||||||||||||
| 902 | ); | ||||||||||||||||||||||||||||
| 903 | |||||||||||||||||||||||||||||
| 904 | 0 | ▶ | if ( defined $synonym_for{$AUTOLOAD} ) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 905 | 0 | $logger->warn("$AUTOLOAD() is deprecated; use $synonym_for{$AUTOLOAD}() instead"); | |||||||||||||||||||||||||||
| 906 | 0 | goto &{ $synonym_for{$AUTOLOAD} }; | |||||||||||||||||||||||||||
| 907 | } | ||||||||||||||||||||||||||||
| 908 | else { | ||||||||||||||||||||||||||||
| 909 | 0 | Bio::NEXUS::Util::Exceptions::UnknownMethod->throw( | |||||||||||||||||||||||||||
| 910 | 'error' => "ERROR: Unknown method $AUTOLOAD called" | ||||||||||||||||||||||||||||
| 911 | ); | ||||||||||||||||||||||||||||
| 912 | } | ||||||||||||||||||||||||||||
| 913 | 0 | return; | |||||||||||||||||||||||||||
| 914 | } | ||||||||||||||||||||||||||||
| 915 | |||||||||||||||||||||||||||||
| 916 | 35 | 1; | |||||||||||||||||||||||||||