-
Notifications
You must be signed in to change notification settings - Fork 182
/
PhyloNetwork.pm
1803 lines (1526 loc) · 43.7 KB
/
PhyloNetwork.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Module for Bio::PhyloNetwork
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Gabriel Cardona <gabriel(dot)cardona(at)uib(dot)es>
#
# Copyright Gabriel Cardona, Gabriel Valiente
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::PhyloNetwork - Module to compute with Phylogenetic Networks
=head1 SYNOPSIS
use Bio::PhyloNetwork;
# Create a PhyloNetwork object from a eNewick string
my $net1=Bio::PhyloNetwork->new(
-eNewick=>'t0:((H1,(H2,l2)),H2); H1:((H3,l1)); H2:((H3,(l3,H1))); H3:(l4);'
);
# Print all available data
print $net1;
# Rebuild $net1 from its mu_data
my %mudata=$net1->mudata();
my $net2=Bio::PhyloNetwork->new(-mudata=>\%mudata,-numleaves=>4);
print $net2;
print "d=".$net1->mu_distance($net2)."\n";
# Get another one and compute distance
my $net3=Bio::PhyloNetwork->new(
-eNewick=>'(l2,((l1,(H1,l4)),H1))r; (l3)H1;'
);
print "d=".$net1->mu_distance($net3)."\n";
# ...and find an optimal alignment w.r.t. the Manhattan distance (default)
my ($weight,%alignment)=$net1->optimal_alignment($net3);
print "weight:$weight\n";
foreach my $node1 (keys %alignment) {
print "$node1 => ".$alignment{$node1}."\n";
}
# ...or the Hamming distance
my ($weightH,%alignmentH)=$net1->optimal_alignment($net3,-metric=>'Hamming');
print "weight:$weightH\n";
foreach my $node1 (keys %alignmentH) {
print "$node1 => ".$alignmentH{$node1}."\n";
}
# Test for time consistency of $net1
if ($net1->is_time_consistent) {
print "net1 is time consistent\n"
}
else {
print "net1 is not time consistent\n"
}
# create a network from the list of edges
my $net4=Bio::PhyloNetwork->new(-edges=>
[qw(r s r t s u s c t c t v u b u l3 u b v b v l4 b l2 c l1)]);
# Test for time consistency of $net3
if ($net4->is_time_consistent) {
print "net4 is time consistent\n"
}
else {
print "net4 is not time consistent\n"
}
# And print all information on net4
print $net4;
# Compute some tripartitions
my %triparts=$net1->tripartitions();
# Now these are stored
print $net1;
# And can compute the tripartition error
print "dtr=".$net1->tripartition_error($net3)."\n";
=head1 DESCRIPTION
=head2 Phylogenetic Networks
This is a module to work with phylogenetic networks. Phylogenetic networks
have been studied over the last years as a richer model of the evolutionary
history of sets of organisms than phylogenetic trees, because they take not
only mutation events but also recombination and horizontal gene transfer
events into account.
The natural model for describing the evolutionary
history of a set of sequences under recombination events is a DAG, hence
this package relies on the package Graph::Directed to represent the
underlying graph of a phylogenetic network. We refer the reader to [CRV1,CRV2]
for formal definitions related to phylogenetic networks.
=head2 eNewick description
With this package, phylogenetic networks can be given by its eNewick
string. This description appeared in other packages related to
phylogenetic networks (see [PhyloNet] and [NetGen]); in fact, these two
packages use different descriptions. The Bio::PhyloNetwork
package allows both of them, but uses the second one in its output.
The first approach [PhyloNet] goes as follows: For each hybrid node H, say with
parents u_1,u_2,...,u_k and children v_1,v_2,...v_l: split H in k+1 different
nodes; let each of the first k copies be a child of one of the u_1,...,u_k
(one for each) and have no children (hence we will have k extra leaves);
as for the last copy, let it have no parents and have v_1,...,v_l be its
children. This way we get a forest; each of the trees will be rooted at either
one root of the phylogenetic network or a hybrid node of it; the set of leaves
(of the whole forest) will be the set of leaves of the original network
together with the set of hybrid nodes (each of them repeated as many times
as its in-degree). Then, the eNewick representation of the phylogenetic network
will be the Newick representation of all the trees in the obtained forest,
each of them with its root labeled.
The second approach [NetGen] goes as follows: For each hybrid node H, say with
parents u_1,u_2,...,u_k and children v_1,v_2,...v_l: split H in k different
nodes; let the first copy be a child of u_1 and have all v_1,v_2,...v_l as
its children; let the other copies be child of u_2,...,u_k (one for each)
and have no children. This way, we get a tree whose set of leaves is the
set of leaves of the original network together with the set of hybrid nodes
(possibly repeated). Then the Newick string of the obtained tree (note that
some internal nodes will be labeled and some leaves will be repeated) is
the eNewick string of the phylogenetic network.
For example, consider the network depicted below:
r
/ \
/ \
U V
/ \ / \
1 \ / 3
H
|
2
If the first approach is taken, we get the forest:
r
/ \
/ \
U V
/ \ / \
1 H H 3
|
H
|
2
Hence, the eNewick string is '((1,H),(H,3))r; (2)H;'.
As for the second one, one gets the tree:
r
/ \
/ \
U V
/ \ / \
1 H | 3
H
|
2
Hence, the eNewick string is '((1,H),((2)H,3))r;'.
Note: when rooting a tree, this package allows the notations
'(subtree,subtree,...)root' as well as 'root:(subtree,subtree,...)', but
the first one is used when writing eNewick strings.
=head2 Tree-child phylogenetic networks
Tree-child (TC) phylogenetic networks are a special class of phylogenetic
networks for which a distance, called mu-distance, is defined [CRV2]
based on certain data (mu-data) associated to every node.
Moreover, this distance extends the
Robinson-Foulds on phylogenetic trees. This package allows testing for a
phylogenetic network if it is TC and computes mu-distances between networks
over the same set of leaves.
Moreover, the mu-data allows one to define the optimal
(in some precise sense) alignment between networks
over the same set of leaves. This package also computes this optimal alignment.
=head2 Tripartitions
Although tripartitions (see [CRV1] and the references therein) do not allow
to define distances, this package outputs tripartitions and computes a weak
form of the tripartition error.
=head2 Time-consistency
Another useful property of Phylogenetic Networks that appears in the literature
is that of time-consistency or real-time hybrids [BSS]. Roughly speaking, a
network admits a temporal representation if it can be drawn in such a way
that tree arcs (those whose end is a tree node) are inclined downwards, while
hybridization arcs (those whose end is a hybrid node) are horizontal.
This package checks for time-consistency and, if so, a temporal representation
is provided.
=head1 AUTHOR
Gabriel Cardona, gabriel(dot)cardona(at)uib(dot)es
Gabriel Valiente, valiente(at)lsi(dot)upc(dot)edu
=head1 SEE ALSO
=over
=item [CRV1]
G. Cardona, F. Rossello, G. Valiente. Tripartitions do not always
discriminate phylogenetic networks. arXiv:0707.2376v1 [q-bio.PE]
=item [CRV2]
G. Cardona, F. Rossello, G. Valiente. A Distance Measure for
Tree-Child Phylogenetic Networks. Preprint.
=item [NetGen]
M.M. Morin, and B.M.E. Moret. NetGen: generating phylogenetic networks
with diploid hybrids. Bioinformatics 22 (2006), 1921-1923
=item [PhyloNet]
PhyloNet: "Phylogenetic Networks Toolkit".
http://bioinfo.cs.rice.edu/phylonet
=item [BSS]
M. Baroni, C. Semple, and M. Steel. Hybrids in Real
Time. Syst. Biol. 55(1):46-56, 2006
=back
=head1 APPENDIX
The rest of the documentation details each of the object methods.
=cut
package Bio::PhyloNetwork;
use strict;
use warnings;
use base qw(Bio::Root::Root);
use Bio::PhyloNetwork::muVector;
use Graph::Directed;
use Bio::TreeIO;
use Bio::Tree::Node;
use IO::String;
use Array::Compare;
use Algorithm::Munkres;
# Creator
=head2 new
Title : new
Usage : my $obj = new Bio::PhyloNetwork();
Function: Creates a new Bio::PhyloNetwork object
Returns : Bio::PhyloNetwork
Args : none
OR
-eNewick => string
OR
-graph => Graph::Directed object
OR
-edges => reference to an array
OR
-tree => Bio::Tree::Tree object
OR
-mudata => reference to a hash,
-leaves => reference to an array
OR
-mudata => reference to a hash,
-numleaves => integer
Returns a Bio::PhyloNetwork object, created according to the data given:
=over 3
=item new()
creates an empty network.
=item new(-eNewick =E<gt> $str)
creates the network whose
Extended Newick representation (see description above) is the string $str.
=item new(-graph =E<gt> $graph)
creates the network with underlying
graph given by the Graph::Directed object $graph
=item new(-tree =E<gt> $tree)
creates a network as a copy of the
Bio::Tree::Tree object in $tree
=item new(-mudata =E<gt> \%mudata, -leaves =E<gt> \@leaves)
creates the network by reconstructing it from its mu-data stored in
\%mudata and with set of leaves in \@leaves.
=item new(-mudata =E<gt> \%mudata, -numleaves =E<gt> $numleaves)
creates the network by reconstructing it from its mu-data stored in
\%mudata and with set of leaves in ("l1".."l$numleaves").
=back
=cut
sub new {
my ($pkg,@args)=@_;
my $self=$pkg->SUPER::new(@args);
my ($eNewick,$edgesR,$leavesR,$numleaves,$graph,$tree,$mudataR)=
$self->_rearrange([qw(ENEWICK
EDGES
LEAVES
NUMLEAVES
GRAPH
TREE
MUDATA)],@args);
bless($self,$pkg);
$self->build_from_eNewick($eNewick) if defined $eNewick;
$self->build_from_edges(@$edgesR) if defined $edgesR;
$self->build_from_graph($graph) if defined $graph;
$self->build_from_tree($tree) if defined $tree;
if ((! defined $leavesR) && (defined $numleaves)) {
my @leaves=map {"l$_"} (1..$numleaves);
$leavesR=\@leaves;
}
$self->build_from_mudata($mudataR,$leavesR)
if ((defined $mudataR) && (defined $leavesR));
return $self;
}
# Builders
sub build_from_edges {
my ($self,@edges)=@_;
my $graph=Graph::Directed->new();
$graph->add_edges(@edges);
$self->{graph}=$graph;
$self->recompute();
my $labels={};
foreach my $node ($self->nodes()) {
$labels->{$node}=$node;
}
$self->{labels}=$labels;
}
sub build_from_graph {
my ($self,$graph)=@_;
my $graphcp=$graph->copy();
$self->{graph}=$graphcp;
$self->recompute();
my $labels={};
foreach my $node ($self->nodes()) {
$labels->{$node}=$node;
}
$self->{labels}=$labels;
}
my $_eN_index;
sub build_from_eNewick {
my ($self,$string)=@_;
$_eN_index=0;
my $graph=Graph::Directed->new();
my $labels={};
my @blocks=split(/; */,$string);
foreach my $block (@blocks) {
my ($rt,$str)=get_root_and_subtree($block);
my ($rtlbl,$rttype,$rtid,$rtlng)=get_label_type_id_length($rt);
process_block($graph,$labels,$block,$rtid);
$labels->{$rtid}=$rtlbl.'';
}
$self->{graph}=$graph;
$self->{labels}=$labels;
$self->recompute();
}
sub process_block {
my ($graph,$labels,$block,$rtid)=@_;
my ($rt,$str)=get_root_and_subtree($block);
my @substrs=my_split($str);
foreach my $substr (@substrs) {
my ($subrt,$subblock)=get_root_and_subtree($substr);
my ($subrtlbl,$subrttype,$subrtid,$subrtlng)=
get_label_type_id_length($subrt);
if (! $subrtlng eq '') {
$graph->add_weighted_edges($rtid,$subrtid,$subrtlng);
}
else {
$graph->add_edges($rtid,$subrtid);
}
if (! $subrttype eq '') {
$graph->set_edge_attribute($rtid,$subrtid,'type',$subrttype);
}
$subrtlbl.='';
# if (! $subrtlbl eq '') {
if ((! defined $labels->{$subrtid})||($labels->{$subrtid} eq '')){
$labels->{$subrtid}=$subrtlbl;
} elsif (( $labels->{$subrtid} ne $subrtlbl )&&($subrtlbl ne '')) {
# error
die("Different labels for the same node (".$labels->{$subrtid}." and $subrtlbl)");
}
# }
if ($subblock ne "") {
process_block($graph,$labels,$subblock,$subrtid);
}
}
}
sub get_root_and_subtree {
my ($block)=@_;
my ($rt,$str)=("","");
# ($rt,$str)=split(/:|=/,$block);
($rt,$str)=split(/=/,$block);
if ($rt eq $block) {
# try to look for root label at the end
my $pos=length($rt)-1;
while ((substr($rt,$pos,1) ne ")") && ($pos >=0)) {
$pos--;
}
$rt=substr($block,$pos+1,length($block)-$pos);
$str=substr($block,0,$pos+1);
}
$rt=trim($rt);
$str=trim($str);
return ($rt,$str);
}
sub get_label_type_id_length {
my ($string) = @_;
$string.='';
# print "$string\n";
if (index($string,'#')==-1) {
# no hybrid
my ($label,$length)=split(':',$string);
$label.='';
my $id;
if ((! defined $label) || ($label eq '')) {
# create id
$_eN_index++;
$id="T$_eN_index";
} else {
$id=$label;
}
return ($label,'',$id,$length);
}
else {
# hybrid
my ($label,$string2)=split('#',$string);
my ($typeid,$length)=split(':',$string2);
my $type=$typeid;
$type =~ s/\d//g;
my $id=$typeid;
$id =~ s/\D//g;
return ($label,$type,'#'.$id,$length);
}
}
sub trim
{
my ($string) = @_;
$string =~ s/^\s+//;
$string =~ s/\s+$//;
return $string;
}
sub my_split {
my ( $string ) = @_;
my $temp="";
my @substrings;
my $level=1;
for my $i ( 1 .. length( $string ) ) {
my $char=substr($string,$i,1);
if ($char eq "(") {
$level++;
}
if ($char eq ")") {
if ($level==1) {
push @substrings, $temp;
$temp="";
}
$level--;
}
if (($char eq ",") && ($level==1)) {
push @substrings, $temp;
$temp="";
$char="";
}
$temp = $temp.$char;
}
return @substrings;
}
sub build_from_mudata {
my ($self,$mus,$leavesR)=@_;
my $graph=Graph::Directed->new();
my @nodes=keys %{$mus};
my @leaves=@{$leavesR};
my %seen;
my @internal;
@seen{@leaves} = ();
foreach my $node (@nodes) {
push(@internal, $node) unless exists $seen{$node};
}
@internal=sort {$mus->{$b} <=> $mus->{$a} } @internal;
@nodes=(@internal,@leaves);
my $numnodes=@nodes;
for (my $i=0;$i<$numnodes;$i++) {
my $mu=$mus->{$nodes[$i]};
my $j=$i+1;
while ($mu->is_positive() && $j<$numnodes) {
if ($mu->geq_poset($mus->{$nodes[$j]})) {
$graph->add_edges(($nodes[$i],$nodes[$j]));
$mu = $mu - $mus->{$nodes[$j]};
}
$j++;
}
}
$self->build_from_graph($graph);
}
# sub relabel_tree {
# my ($tree)=@_;
# my $i=1;
# my $j=1;
# my $root=$tree->get_root_node();
# foreach my $node ($tree->get_nodes()) {
# if ($node == $root) {
# $node->{'_id'}="r";
# }
# elsif (! $node->is_Leaf) {
# $node->{'_id'}="t$i";
# $i++;
# }
# else {
# if ($node->{'_id'} eq "") {
# $node->{'_id'}="l$j";
# $j++;
# }
# }
# }
# return $tree;
# }
# sub build_subtree {
# my ($graph,$root)=@_;
# foreach my $child ($root->each_Descendent) {
# $graph->add_edge($root->id,$child->id);
# $graph=build_subtree($graph,$child);
# }
# return $graph;
# }
sub build_from_tree {
my ($self,$tree)=@_;
# relabel_tree($tree);
# my $treeroot=$tree->get_root_node;
# my $graph=Graph::Directed->new();
# $graph=build_subtree($graph,$treeroot);
# $self->build_from_graph($graph);
my $str;
my $io=IO::String->new($str);
my $treeio=Bio::TreeIO->new(-format => 'newick', -fh => $io);
$treeio->write_tree($tree);
# print "intern: $str\n";
$self->build_from_eNewick($str);
}
sub recompute {
my ($self)=@_;
$self->throw("Graph is not DAG:".$self->{graph})
unless $self->{graph}->is_dag();
my @leaves=$self->{graph}->successorless_vertices();
@leaves=sort @leaves;
my $numleaves=@leaves;
my @roots=$self->{graph}->predecessorless_vertices();
my $numroots=@roots;
#$self->throw("Graph is not rooted") unless ($numroots == 1);
my @nodes=$self->{graph}->vertices();
@nodes=sort @nodes;
my $numnodes=@nodes;
foreach my $node (@nodes) {
if (! defined $self->{labels}->{$node}) {
$self->{labels}->{$node}='';
}
}
$self->{leaves}=\@leaves;
$self->{numleaves}=$numleaves;
$self->{roots}=\@roots;
$self->{numroots}=$numroots;
$self->{nodes}=\@nodes;
$self->{numnodes}=$numnodes;
$self->{mudata}={};
$self->{h}={};
$self->compute_height();
$self->compute_mu();
return $self;
}
# Hybridizing
sub is_attackable {
my ($self,$u1,$v1,$u2,$v2)=@_;
if ( $self->is_hybrid_node($v1) ||
$self->is_hybrid_node($v2) ||
$self->graph->is_reachable($v2,$u1) ||
(($u1 eq $u2)&&($v1 eq $v2)) ||
(! scalar grep {($_ ne $v2) && ($self->is_tree_node($_))}
$self->graph->successors($u2)))
{
return 0;
}
return 1;
}
sub do_attack {
my ($self,$u1,$v1,$u2,$v2,$lbl)=@_;
my $graph=$self->{graph};
$graph->delete_edge($u1,$v1);
$graph->delete_edge($u2,$v2);
$graph->add_edge($u1,"T$lbl");
$graph->add_edge("T$lbl",$v1);
$graph->add_edge($u2,"#H$lbl");
$graph->add_edge("#H$lbl",$v2);
$graph->add_edge("T$lbl","#H$lbl");
$self->build_from_graph($graph);
}
# Computation of mu-data
sub compute_mu {
my ($self)=@_;
my $graph=$self->{graph};
my $mudata=$self->{mudata};
my @leaves=@{$self->{leaves}};
my $numleaves=$self->{numleaves};
for (my $i=0;$i<$numleaves;$i++) {
my $vec=Bio::PhyloNetwork::muVector->new($numleaves);
$vec->[$i]=1;
$mudata->{$leaves[$i]}=$vec;
}
my $h=1;
while (my @nodes=grep {$self->{h}->{$_} == $h} @{$self->{nodes}} )
{
foreach my $u (@nodes) {
my $vec=Bio::PhyloNetwork::muVector->new($numleaves);
foreach my $son ($graph->successors($u)) {
$vec+=$mudata->{$son};
}
$mudata->{$u}=$vec;
}
$h++;
}
}
sub compute_height {
my ($self)=@_;
my $graph=$self->{graph};
my @leaves=@{$self->{leaves}};
foreach my $leaf (@leaves) {
$self->{h}->{$leaf}=0;
}
my $h=0;
while (my @nodes=grep {(defined $self->{h}->{$_})&&($self->{h}->{$_} == $h)}
@{$self->{nodes}} )
{
foreach my $node (@nodes) {
foreach my $parent ($graph->predecessors($node)) {
$self->{h}->{$parent}=$h+1;
}
}
$h++;
}
}
# Tests
=head2 is_leaf
Title : is_leaf
Usage : my $b=$net->is_leaf($u)
Function: tests if $u is a leaf in $net
Returns : boolean
Args : scalar
=cut
sub is_leaf {
my ($self,$node)=@_;
if ($self->{graph}->out_degree($node) == 0) {return 1;}
return 0;
}
=head2 is_root
Title : is_root
Usage : my $b=$net->is_root($u)
Function: tests if $u is the root of $net
Returns : boolean
Args : scalar
=cut
sub is_root {
my ($self,$node)=@_;
if ($self->{graph}->in_degree($node) == 0) {return 1;}
return 0;
}
=head2 is_tree_node
Title : is_tree_node
Usage : my $b=$net->is_tree_node($u)
Function: tests if $u is a tree node in $net
Returns : boolean
Args : scalar
=cut
sub is_tree_node {
my ($self,$node)=@_;
if ($self->{graph}->in_degree($node) <= 1) {return 1;}
return 0;
}
=head2 is_hybrid_node
Title : is_hybrid_node
Usage : my $b=$net->is_hybrid_node($u)
Function: tests if $u is a hybrid node in $net
Returns : boolean
Args : scalar
=cut
sub is_hybrid_node {
my ($self,$node)=@_;
if ($self->{graph}->in_degree($node) > 1) {return 1;}
return 0;
}
sub has_tree_child {
# has_tree_child(g,u) returns 1 if u has a tree child in graph g
# and 0 otherwise
my $g=shift(@_);
my $node=shift(@_);
my @Sons=$g->successors($node);
foreach my $son (@Sons) {
if ($g->in_degree($son)==1) {
return 1;
}
}
return 0;
}
=head2 is_tree_child
Title : is_tree_child
Usage : my $b=$net->is_tree_child()
Function: tests if $net is a Tree-Child phylogenetic network
Returns : boolean
Args : Bio::PhyloNetwork
=cut
sub is_tree_child {
my ($self)=@_;
if (defined $self->{is_tree_child}) {
return $self->{is_tree_child};
}
$self->{is_tree_child}=0;
my $graph=$self->{graph};
foreach my $node (@{$self->{nodes}}) {
return 0 unless ($graph->out_degree($node)==0 ||
has_tree_child($graph,$node));
}
$self->{is_tree_child}=1;
return 1;
}
# Accessors
=head2 nodes
Title : nodes
Usage : my @nodes=$net->nodes()
Function: returns the set of nodes of $net
Returns : array
Args : none
=cut
sub nodes {
my ($self)=@_;
return @{$self->{nodes}};
}
=head2 leaves
Title : leaves
Usage : my @leaves=$net->leaves()
Function: returns the set of leaves of $net
Returns : array
Args : none
=cut
sub leaves {
my ($self)=@_;
return @{$self->{leaves}};
}
=head2 roots
Title : roots
Usage : my @roots=$net->roots()
Function: returns the set of roots of $net
Returns : array
Args : none
=cut
sub roots {
my ($self)=@_;
return @{$self->{roots}};
}
=head2 internal_nodes
Title : internal_nodes
Usage : my @internal_nodes=$net->internal_nodes()
Function: returns the set of internal nodes of $net
Returns : array
Args : none
=cut
sub internal_nodes {
my ($self)=@_;
return grep {! $self->is_leaf($_)} $self->nodes();
}
=head2 tree_nodes
Title : tree_nodes
Usage : my @tree_nodes=$net->tree_nodes()
Function: returns the set of tree nodes of $net
Returns : array
Args : none
=cut
sub tree_nodes {
my ($self)=@_;
return grep {$self->is_tree_node($_)} $self->nodes();
}
=head2 hybrid_nodes
Title : hybrid_nodes
Usage : my @hybrid_nodes=$net->hybrid_nodes()
Function: returns the set of hybrid nodes of $net
Returns : array
Args : none
=cut
sub hybrid_nodes {
my ($self)=@_;
return grep {$self->is_hybrid_node($_)} $self->nodes();
}
=head2 graph
Title : graph
Usage : my $graph=$net->graph()
Function: returns the underlying graph of $net
Returns : Graph::Directed
Args : none
=cut
sub graph {
my ($self)=@_;
return $self->{graph};
}
=head2 edges
Title : edges
Usage : my @edges=$net->edges()
Function: returns the set of edges of $net
Returns : array
Args : none
Each element in the array is an anonimous array whose first element is the
head of the edge and the second one is the tail.
=cut
sub edges {
my ($self)=@_;
return $self->{graph}->edges();
}
=head2 tree_edges
Title : tree_edges
Usage : my @tree_edges=$net->tree_edges()
Function: returns the set of tree edges of $net
(those whose tail is a tree node)
Returns : array
Args : none
=cut
sub tree_edges {
my ($self)=@_;
return grep {$self->is_tree_node($_->[1])} $self->edges();
}
=head2 hybrid_edges
Title : hybrid_edges
Usage : my @hybrid_edges=$net->hybrid_edges()
Function: returns the set of hybrid edges of $net
(those whose tail is a hybrid node)
Returns : array
Args : none
=cut
sub hybrid_edges {
my ($self)=@_;
return grep {$self->is_hybrid_node($_->[1])} $self->edges();
}
=head2 explode
Title : explode
Usage : my @trees=$net->explode()
Function: returns the representation of $net by a set of
Bio::Tree:Tree objects
Returns : array
Args : none
=cut
sub explode {
my ($self)=@_;
my @trees;
$self->explode_rec(\@trees);
return @trees;
}
sub explode_rec {
my ($self,$trees)=@_;
my @h = $self->hybrid_nodes;
if (scalar @h) {
my $v = shift @h;
for my $u ($self->{graph}->predecessors($v)) {
$self->{graph}->delete_edge($u,$v);
$self->explode_rec($trees);
$self->{graph}->add_edge($u,$v);
}
} else {
my $io = IO::String->new($self->eNewick);
my $treeio = Bio::TreeIO->new(-format => 'newick', -fh => $io);
my $tree = $treeio->next_tree;
$tree->contract_linear_paths;
push @{$trees}, $tree;
}
}