annotate variant_effect_predictor/Bio/Tree/TreeFunctionsI.pm @ 0:2bc9b66ada89 draft default tip

Uploaded
author mahtabm
date Thu, 11 Apr 2013 06:29:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
1 # $Id: TreeFunctionsI.pm,v 1.5.2.3 2003/09/14 20:18:25 jason Exp $
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
2 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
3 # BioPerl module for Bio::Tree::TreeFunctionsI
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
4 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
5 # Cared for by Jason Stajich <jason@bioperl.org>
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
6 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
7 # Copyright Jason Stajich
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
8 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
10
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
11 # POD documentation - main docs before the code
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
12
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
13 =head1 NAME
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
14
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
15 Bio::Tree::TreeFunctionsI - Decorated Interface implementing basic Tree exploration methods
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
16
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
17 =head1 SYNOPSIS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
18
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
19 use Bio::TreeIO;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20 my $in = new Bio::TreeIO(-format => 'newick', -file => 'tree.tre');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22 my $tree = $in->next_tree;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24 my @nodes = $tree->find_node('id1');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26 if( $tree->is_monophyletic(-clade => @nodes, -outgroup => $outnode) ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32 Describe the interface here
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34 =head1 FEEDBACK
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36 =head2 Mailing Lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38 User feedback is an integral part of the evolution of this and other
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39 Bioperl modules. Send your comments and suggestions preferably to
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40 the Bioperl mailing list. Your participation is much appreciated.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42 bioperl-l@bioperl.org - General discussion
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43 http://bioperl.org/MailList.shtml - About the mailing lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45 =head2 Reporting Bugs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47 Report bugs to the Bioperl bug tracking system to help us keep track
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48 of the bugs and their resolution. Bug reports can be submitted via
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 email or the web:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51 bioperl-bugs@bioperl.org
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52 http://bugzilla.bioperl.org/
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54 =head1 AUTHOR - Jason Stajich, Aaron Mackey, Justin Reese
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56 Email jason-at-bioperl-dot-org
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57 Email amackey-at-virginia.edu
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58 Email jtr4v-at-virginia.edu
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60 =head1 CONTRIBUTORS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 Additional contributors names and emails here
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 Rerooting code was worked on by
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 Daniel Barker d.barker-at-reading.ac.uk
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67 Ramiro Barrantes Ramiro.Barrantes-at-uvm.edu
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 =head1 APPENDIX
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71 The rest of the documentation details each of the object methods.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 Internal methods are usually preceded with a _
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77 # Let the code begin...
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80 package Bio::Tree::TreeFunctionsI;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 use vars qw(@ISA);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 use Bio::Tree::TreeI;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85 @ISA = qw(Bio::Tree::TreeI);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87 =head2 find_node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89 Title : find_node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90 Usage : my @nodes = $self->find_node(-id => 'node1');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91 Function: returns all nodes that match a specific field, by default this
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 is id, but different branch_length,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93 Returns : List of nodes which matched search
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94 Args : text string to search for
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 OR
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96 -fieldname => $textstring
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100 sub find_node {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 my ($self,$type,$field) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102 if( ! defined $type ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103 $self->warn("Must request a either a string or field and string when searching");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106 # all this work for a '-' named field
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107 # is so that we could potentially
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108 # expand to other constraints in
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109 # different implementations
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 # like 'find all nodes with boostrap < XX'
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112 if( ! defined $field ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113 # only 1 argument, default to searching by id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114 $field= $type;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115 $type = 'id';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117 $type =~ s/^-//;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120 # could actually do this by testing $rootnode->can($type) but
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
121 # it is possible that a tree is implemeted with different node types
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
122 # - although it is unlikely that the root node would be richer than the
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
123 # leaf nodes. Can't handle NHX tags right now
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
124
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 unless( $type eq 'id' || $type eq 'name' ||
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126 $type eq 'bootstrap' || $type eq 'description' ||
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127 $type eq 'internal_id') {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 $self->warn("unknown search type $type - will try anyways");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130 my @nodes = grep { $_->can($type) && defined $_->$type() &&
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131 $_->$type() eq $field } $self->get_nodes();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 if ( wantarray) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134 return @nodes;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 if( @nodes > 1 ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137 $self->warn("More than 1 node found but caller requested scalar, only returning first node");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139 return shift @nodes;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143 =head2 remove_Node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145 Title : remove_Node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146 Usage : $tree->remove_Node($node)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 Function: Removes a node from the tree
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148 Returns : boolean represent status of success
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149 Args : either Bio::Tree::NodeI or string of the node id
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
152 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
153
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
154 sub remove_Node {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
155 my ($self,$input) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
156 my $node = undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
157 unless( ref($input) ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
158 $node = $self->find_node($input);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
159 } elsif( ! $input->isa('Bio::Tree::NodeI') ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
160 $self->warn("Did not provide either a valid Bio::Tree::NodeI object to remove_node or the node name");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
161 return 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
162 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
163 $node = $input;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
164 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
165 if( ! $node->ancestor && $self->get_root_node->internal_id != $node->internal_id) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
166 $self->warn("Node (".$node->to_string . ") has no ancestor, can't remove!");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
167 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
168 $node->ancestor->remove_Descendent($node);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
169 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
170 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
171
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
172
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
173 # Added for Justin Reese by Jason
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
174
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
175 =head2 get_lca
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
176
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
177 Title : get_lca
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
178 Usage : get_lca(-nodes => \@nodes )
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
179 Function: given two nodes, returns the lowest common ancestor
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
180 Returns : node object
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
181 Args : -nodes => arrayref of nodes to test
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
182
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
183
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
184 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
185
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
186 sub get_lca {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
187 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
188 my ($nodes) = $self->_rearrange([qw(NODES)],@args);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
189 if( ! defined $nodes ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
190 $self->warn("Must supply -nodes parameter to get_lca() method");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
191 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
192 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
193 my ($node1,$node2) = $self->_check_two_nodes($nodes);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
194 return undef unless $node1 && $node2;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
195
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
196 # algorithm: Start with first node, find and save every node from it to
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
197 # root. Then start with second node; for it and each of its ancestor
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
198 # nodes, check to see if it's in the first node's ancestor list - if
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
199 # so it is the lca.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
200 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
201 # This is very slow and naive, but I somehow doubt the overhead
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
202 # of mapping the tree to a complete binary tree and doing the linear
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
203 # lca search would be worth the overhead, especially for small trees.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
204 # Maybe someday I'll write a linear get_lca and find out.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
205
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
206 # find and save every ancestor of node1 (including itself)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
207
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
208 my %node1_ancestors; # keys are internal ids, values are objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
209 my $place = $node1; # start at node1
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
210
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
211 while ( $place ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
212 $node1_ancestors{$place->internal_id} = $place;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
213 $place = $place->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
214 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
215
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
216 # now climb up node2, for each node checking whether
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
217 # it's in node1_ancestors
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
218 $place = $node2; # start at node2
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
219 while ( $place ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
220 foreach my $key ( keys %node1_ancestors ){ # ugh
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
221 if ( $place->internal_id == $key){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
222 return $node1_ancestors{$key};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
223 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
224 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
225 $place = $place->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
226 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
227 $self->warn("Could not find lca!"); # should never execute,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
228 # if so, there's a problem
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
229 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
230 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
231
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
232 # Added for Justin Reese by Jason
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
233
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
234 =head2 distance
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
235
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
236 Title : distance
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
237 Usage : distance(-nodes => \@nodes )
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
238 Function: returns the distance between two given nodes
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
239 Returns : numerical distance
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
240 Args : -nodes => arrayref of nodes to test
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
241
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
242
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
243 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
244
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
245 sub distance {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
246 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
247 my ($nodes) = $self->_rearrange([qw(NODES)],@args);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
248 if( ! defined $nodes ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
249 $self->warn("Must supply -nodes parameter to distance() method");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
250 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
251 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
252 my ($node1,$node2) = $self->_check_two_nodes($nodes);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
253 # algorithm:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
254
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
255 # Find lca: Start with first node, find and save every node from it
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
256 # to root, saving cumulative distance. Then start with second node;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
257 # for it and each of its ancestor nodes, check to see if it's in
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
258 # the first node's ancestor list - if so it is the lca. Return sum
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
259 # of (cumul. distance from node1 to lca) and (cumul. distance from
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
260 # node2 to lca)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
261
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
262 # find and save every ancestor of node1 (including itself)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
263
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
264 my %node1_ancestors; # keys are internal ids, values are objects
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
265 my %node1_cumul_dist; # keys are internal ids, values
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
266 # are cumulative distance from node1 to given node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
267 my $place = $node1; # start at node1
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
268 my $cumul_dist = 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
269
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
270 while ( $place ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
271 $node1_ancestors{$place->internal_id} = $place;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
272 $node1_cumul_dist{$place->internal_id} = $cumul_dist;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
273 if ($place->branch_length) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
274 $cumul_dist += $place->branch_length; # include current branch
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
275 # length in next iteration
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
276 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
277 $place = $place->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
278 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
279
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
280 # now climb up node2, for each node checking whether
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
281 # it's in node1_ancestors
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
282 $place = $node2; # start at node2
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
283 $cumul_dist = 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
284 while ( $place ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
285 foreach my $key ( keys %node1_ancestors ){ # ugh
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
286 if ( $place->internal_id == $key){ # we're at lca
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
287 return $node1_cumul_dist{$key} + $cumul_dist;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
288 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
289 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
290 # include current branch length in next iteration
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
291 $cumul_dist += $place->branch_length;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
292 $place = $place->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
293 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
294 $self->warn("Could not find distance!"); # should never execute,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
295 # if so, there's a problem
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
296 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
297 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
298
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
299 # helper function to check lca and distance arguments
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
300
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
301 sub _check_two_nodes {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
302 my ($self, $nodes) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
303
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
304 if( ref($nodes) !~ /ARRAY/i ||
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
305 !ref($nodes->[0]) ||
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
306 !ref($nodes->[1])
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
307 ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
308 $self->warn("Must provide a valid array reference for -nodes");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
309 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
310 } elsif( scalar(@$nodes) > 2 ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
311 $self->warn("More than two nodes given, using first two");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
312 } elsif( scalar(@$nodes) < 2 ){
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
313 $self->warn("-nodes parameter does not contain reference to two nodes");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
314 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
315 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
316 unless( $nodes->[0]->isa('Bio::Tree::NodeI') &&
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
317 $nodes->[1]->isa('Bio::Tree::NodeI') ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
318 $self->warn("Did not provide valid Bio::Tree::NodeI objects as nodes\n");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
319 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
320 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
321 return @$nodes;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
322 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
323
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
324
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
325 =head2 is_monophyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
326
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
327 Title : is_monophyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
328 Usage : if( $tree->is_monophyletic(-nodes => \@nodes,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
329 -outgroup => $outgroup)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
330 Function: Will do a test of monophyly for the nodes specified
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
331 in comparison to a chosen outgroup
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
332 Returns : boolean
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
333 Args : -nodes => arrayref of nodes to test
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
334 -outgroup => outgroup to serve as a reference
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
335
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
336
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
337 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
338
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
339 sub is_monophyletic{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
340 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
341 my ($nodes,$outgroup) = $self->_rearrange([qw(NODES OUTGROUP)],@args);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
342
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
343 if( ! defined $nodes || ! defined $outgroup ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
344 $self->warn("Must supply -nodes and -outgroup parameters to the method
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
345 is_monophyletic");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
346 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
347 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
348 if( ref($nodes) !~ /ARRAY/i ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
349 $self->warn("Must provide a valid array reference for -nodes");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
350 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
351 my $clade_root;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
352 # this is to combine multiple tests into a single node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
353 # order doesn't really matter as long as get_lca does its job right
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
354 while( @$nodes > 2 ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
355 my ($a,$b) = ( shift @$nodes, shift @$nodes);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
356 $clade_root = $self->get_lca(-nodes => [$a,$b] );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
357 unshift @$nodes, $clade_root;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
358 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
359 $clade_root = $self->get_lca(-nodes => $nodes );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
360 my $og_ancestor = $outgroup->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
361 while( defined ($og_ancestor ) ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
362 if( $og_ancestor->internal_id == $clade_root->internal_id ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
363 # monophyly is violated
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
364 return 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
365 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
366 $og_ancestor = $og_ancestor->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
367 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
368 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
369 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
370
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
371 =head2 is_paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
372
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
373 Title : is_paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
374 Usage : if( $tree->is_paraphyletic(-nodes =>\@nodes,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
375 -outgroup => $node) ){ }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
376 Function: Tests whether or not a given set of nodes are paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
377 (representing the full clade) given an outgroup
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
378 Returns : [-1,0,1] , -1 if the group is not monophyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
379 0 if the group is not paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
380 1 if the group is paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
381 Args : -nodes => Array of Bio::Tree::NodeI objects which are in the tree
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
382 -outgroup => a Bio::Tree::NodeI to compare the nodes to
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
383
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
384
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
385 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
386
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
387 sub is_paraphyletic{
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
388 my ($self,@args) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
389 my ($nodes,$outgroup) = $self->_rearrange([qw(NODES OUTGROUP)],@args);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
390
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
391 if( ! defined $nodes || ! defined $outgroup ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
392 $self->warn("Must suply -nodes and -outgroup parameters to the method is_paraphyletic");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
393 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
394 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
395 if( ref($nodes) !~ /ARRAY/i ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
396 $self->warn("Must provide a valid array reference for -nodes");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
397 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
398 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
399
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
400 # Algorithm
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
401 # Find the lca
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
402 # Find all the nodes beneath the lca
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
403 # Test to see that none are missing from the nodes list
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
404 my %nodehash;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
405 foreach my $n ( @$nodes ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
406 $nodehash{$n->internal_id} = $n;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
407 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
408 while( @$nodes > 2 ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
409 unshift @$nodes, $self->get_lca(-nodes => [( shift @$nodes,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
410 shift @$nodes)] );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
411 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
412 my $clade_root = $self->get_lca(-nodes => $nodes );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
413 unless( defined $clade_root ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
414 $self->warn("could not find clade root via lca");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
415 return undef;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
416 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
417 my $og_ancestor = $outgroup->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
418
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
419 # Is this necessary/correct for paraphyly test?
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
420 while( defined ($og_ancestor ) ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
421 if( $og_ancestor->internal_id == $clade_root->internal_id ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
422 # monophyly is violated, could be paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
423 return -1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
424 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
425 $og_ancestor = $og_ancestor->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
426 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
427 my $tree = new Bio::Tree::Tree(-root => $clade_root,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
428 -nodelete => 1);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
429
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
430 foreach my $n ( $tree->get_nodes() ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
431 next unless $n->is_Leaf();
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
432 # if any leaf node is not in the list
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
433 # then it is part of the clade and so the list
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
434 # must be paraphyletic
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
435 return 1 unless ( $nodehash{$n->internal_id} );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
436 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
437 return 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
438 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
439
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
440
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
441 =head2 reroot
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
442
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
443 Title : reroot_tree
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
444 Usage : $tree->reroot($node);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
445 Function: Reroots a tree either making a new node the root
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
446 Returns : 1 on success, 0 on failure
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
447 Args : Bio::Tree::NodeI that is in the tree, but is not the current root
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
448
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
449 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
450
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
451 sub reroot {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
452 my ($self,$new_root) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
453 unless (defined $new_root && $new_root->isa("Bio::Tree::NodeI")) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
454 $self->warn("Must provide a valid Bio::Tree::NodeI when rerooting");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
455 return 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
456 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
457 if( $new_root->is_Leaf() ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
458 $self->warn("Asking to root with a leaf, will use the leaf's ancestor");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
459 $new_root = $new_root->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
460 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
461
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
462 my $old_root = $self->get_root_node;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
463 if( $new_root == $old_root ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
464 $self->warn("Node requested for reroot is already the root node!");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
465 return 0;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
466 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
467
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
468 my @path = (); # along tree, from newroot to oldroot
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
469 my $node = $new_root;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
470 while ($node) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
471 push @path, $node;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
472 $node = $node->ancestor;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
473 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
474
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
475 my @path_from_oldroot = reverse @path;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
476 for (my $i = 0; $i < @path_from_oldroot - 1; $i++) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
477 my $current = $path_from_oldroot[$i];
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
478 my $next = $path_from_oldroot[$i + 1];
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
479 $current->remove_Descendent($next);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
480 $current->branch_length($next->branch_length);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
481 $next->add_Descendent($current);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
482
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
483 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
484 $new_root->branch_length(undef);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
485 $self->set_root_node($new_root);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
486
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
487 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
488 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
489
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
490 =head2 reverse_edge
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
491
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
492 Title : reverse_edge
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
493 Usage : $node->reverse_edge(child);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
494 Function: makes child be a parent of node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
495 Requires: child must be a direct descendent of node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
496 Returns : nothing
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
497 Args : Bio::Tree::NodeI that is in the tree
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
498
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
499 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
500
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
501 sub reverse_edge {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
502 my ($self,$node) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
503 delete_edge($self, $node);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
504 $node->add_Descendent($self);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
505 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
506 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
507
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
508 =head2 delete_edge
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
509
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
510 Title : delete_edge
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
511 Usage : $node->reverse_edge(child);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
512 Function: makes child be a parent of node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
513 Requires: child must be a direct descendent of node
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
514 Returns : nothing
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
515 Args : Bio::Tree::NodeI that is in the tree
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
516
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
517 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
518
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
519 sub delete_edge {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
520 my ($self,$node) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
521 unless (defined $self && $self->isa("Bio::Tree::NodeI")) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
522 $self->warn("Must provide a valid Bio::Tree::NodeI when rerooting");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
523 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
524 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
525 unless (defined $node && $node->isa("Bio::Tree::NodeI")) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
526 $self->warn("Must provide a valid Bio::Tree::NodeI when rerooting");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
527 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
528 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
529 if( $self->{'_desc'}->{$node->internal_id} ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
530 $node->ancestor(undef);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
531 $self->{'_desc'}->{$node->internal_id}->ancestor(undef);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
532 delete $self->{'_desc'}->{$node->internal_id};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
533 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
534 $self->warn("First argument must be direct parent of node");
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
535 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
536 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
537 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
538 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
539
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
540 sub findnode_by_id {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
541 my $tree = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
542 my $id = shift;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
543 my $rootnode = $tree->get_root_node;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
544 if ( ($rootnode->id) and ($rootnode->id eq $id) ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
545 return $rootnode;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
546 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
547 # process all the children
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
548 foreach my $node ( $rootnode->get_Descendents ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
549 if ( ($node->id) and ($node->id eq $id ) ) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
550 return $node;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
551 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
552 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
553 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
554
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
555 1;