Bio::TreeIO
nexus
Summary
Bio::TreeIO::nexus - A TreeIO driver module for parsing Nexus tree output from PAUP
Package variables
No package variables defined.
Included modules
Inherit
Synopsis
use Bio::TreeIO;
my $in = new Bio::TreeIO(-file => 't/data/cat_tre.tre');
while( my $tree = $in->next_tree ) {
}
Description
This is a driver module for parsing PAUP Nexus tree format which
basically is just a remapping of trees.
Methods
Methods description
Title : next_tree Usage : my $tree = $treeio->next_tree Function: Gets the next tree in the stream Returns : Bio::Tree::TreeI Args : none |
Title : write_tree Usage : $treeio->write_tree($tree); Function: Writes a tree onto the stream Returns : none Args : Bio::Tree::TreeI |
Title : header Usage : $obj->header($newval) Function: Example : Returns : value of header (a scalar) Args : on set, new value (a scalar or undef, optional) |
Title : translate_node Usage : $obj->translate_node($newval) Function: Example : Returns : value of translate_node (a scalar) Args : on set, new value (a scalar or undef, optional) |
Methods code
sub _initialize
{ my $self = shift;
$self->SUPER::_initialize(@_);
my ($hdr,$trans) = $self->_rearrange([qw(HEADER
TRANSLATE)],
@_);
$self->header(defined $hdr ? $hdr : 1 );
$self->translate_node(defined $trans ? $trans : 1);} |
sub next_tree
{ my ($self) = @_;
unless ( $self->{'_parsed'} ) {
$self->_parse;
}
return $self->{'_trees'}->[$self->{'_treeiter'}++];} |
sub rewind
{ shift->{'_treeiter'} = 0;} |
sub _parse
{ my ($self) = @_;
$self->{'_parsed'} = 1;
$self->{'_treeiter'} = 0;
while( defined ( $_ = $self->_readline ) ) {
next if /^\s+$/;
last;
}
return unless( defined $_ );
unless( /^\#NEXUS/i ) {
$self->warn("File does not start with #NEXUS"); return;
}
my $line;
my %translate;
while( defined ( $_ = $self->_readline ) ) {
$line .= $_;
}
$line =~ s/\n/ /g;
my @sections = split(/#NEXUS/i, $line);
for my $s ( @sections ) {
if( $self->verbose > 0 ) {
while( $s =~ s/(\[[^\]]+\])// ) {
$self->debug("removing comment $1\n");
}
} else {
$s =~ s/(\[[^\]]+\])//g;
}
if( $s =~ /begin trees;(.+)(end;)?/i ) {
my $trees = $1;
if( $trees =~ s/\s+translate\s+([^;]+);//i ) {
my $trans = $1;
for my $n ( split(/\s*,\s*/,$trans) ) {
my ($id,$tag) = split(/\s+/,$n);
$translate{$id} = $tag;
}
} else {
$self->debug("no translate in: $trees\n");
}
while( $trees =~ /\s+tree\s+(\S+)\s*\= \s*(?:\[\S+\])?\s*([^\;]+;)\s*/igx) {
my ($tree_name,$tree_str) = ($1,$2);
my $buf = new IO::String($tree_str);
my $treeio = new Bio::TreeIO(-format => 'newick',
-fh => $buf);
my $tree = $treeio->next_tree;
foreach my $node ( grep { $_->is_Leaf } $tree->get_nodes ) {
my $id = $node->id;
my $lookup = $translate{$id};
$node->id($lookup || $id);
}
$tree->id($tree_name) if defined $tree_name;
push @{$self->{'_trees'}},$tree;
}
} else {
$self->debug("begin_trees failed: $s\n");
}} |
sub write_tree
{ my ($self,@trees) = @_;
if ( $self->header ) {
$self->_print("#NEXUS\n\n");
}
my $translate = $self->translate_node;
my $time = localtime();
$self->_print(sprintf("Begin trees; [Treefile created %s]\n",$time));
my ($first,$nodecter,%node2num) = (0,1);
foreach my $tree ( @trees ) {
if( $first == 0 &&
$translate ) {
$self->_print("\tTranslate\n");
$self->_print(join(",\n",
map { $node2num{$_->id} = $nodecter;
sprintf("\t\t%d %s",$nodecter++,$_->id) }
grep { $_->is_Leaf } $tree->get_nodes),
"\n;\n");
}
my @data = _write_tree_Helper($tree->get_root_node,\%node2num);
if($data[-1] !~ /\)$/ ) {
$data[0] = "(".$data[0];
$data[-1] .= ")";
}
$self->_print(sprintf("\t tree %s = [&%s] %s;\n",
($tree->id ||
sprintf("Bioperl_%d",$first+1)),
( $tree->get_root_node ) ? 'R' : 'U',
join(',', @data)));
$first++;
}
$self->_print("End;\n");
$self->flush if $self->_flush_on_write && defined $self->_fh;
return;} |
sub _write_tree_Helper
{ my ($node,$node2num) = @_;
return () if (!defined $node);
my @data;
foreach my $n ( $node->each_Descendent() ) {
push @data, _write_tree_Helper($n,$node2num);
}
if( @data > 1 ) {
$data[0] = "(" . $data[0];
$data[-1] .= ")";
my $b;
my $bl = $node->branch_length;
if( ! defined $bl ) {
} elsif($bl =~ /\#/ ) {
$data[-1] .= $bl;
} else {
$data[-1] .= ":$bl";
}
if( defined ($b = $node->bootstrap) ) {
$data[-1] .= sprintf("[%s]",$b);
} elsif( defined ($b = $node->id) ) {
$b = $node2num->{$b} if( $node2num->{$b} ); $data[-1] .= sprintf("[%s]",$b);
}
} else {
if( defined $node->id || defined $node->branch_length ) {
my $id= defined $node->id ? $node->id : '';
if( length($id) && $node2num->{$id} ) {
$id = $node2num->{$id};
}
push @data, sprintf("%s%s",$id,
defined $node->branch_length ? ":" .
$node->branch_length : '');
}
}
return @data;} |
sub header
{ my $self = shift;
return $self->{'header'} = shift if @_;
return $self->{'header'};} |
sub translate_node
{ my $self = shift;
return $self->{'translate_node'} = shift if @_;
return $self->{'translate_node'};} |
General documentation
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
the web:
http://bugzilla.open-bio.org/
| AUTHOR - Jason Stajich | Top |
Email jason-at-open-bio-dot-org
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
Title : new
Args : -header => boolean default is true
print/do not print #NEXUS header
-translate => boolean default is true
print/do not print Node Id translation to a number