NAME

Bio::Phylo::Unparsers::Newick - An object-oriented module for unparsing tree objects into Newick formatted strings.

SYNOPSIS

my $newick = new Bio::Phylo::Unparsers::Newick;
my $string = $newick->unparse($tree);

DESCRIPTION

This module turns a tree object into a newick formatted (parenthetical) tree description.

METHODS

CONSTRUCTOR

new()

Type    : Constructor
Title   : new
Usage   : my $newick = new Bio::Phylo::Unparsers::Newick;
Function: Initializes a Bio::Phylo::Unparsers::Newick object.
Returns : A Bio::Phylo::Unparsers::Newick object.
Args    : none.

UNPARSER

to_string($tree), unparse

Type    : Wrapper
Title   : to_string($tree)
Usage   : $newick->to_string($tree);
Function: Prepares for the recursion to unparse the tree object into a
          newick string.
Alias   :
Returns : SCALAR
Args    : Bio::Phylo::Trees::Tree

_to_string(Bio::Phylo::Trees::Tree, Bio::Phylo::Trees::Node)

Type    : Unparser
Title   : _to_string
Usage   : $newick->_to_string($tree, $node);
Function: Unparses the tree object into a newick string.
Alias   :
Returns : SCALAR
Args    : A Bio::Phylo::Trees::Tree object. Optional: A Bio::Phylo::Trees::Node
          object, the starting point for recursion.

CONTAINER

container

Type    : Internal method
Title   : container
Usage   : $newick->container;
Function:
Alias   :
Returns : SCALAR
Args    :

container_type

Type    : Internal method
Title   : container_type
Usage   : $newick->container_type;
Function:
Alias   :
Returns : SCALAR
Args    :

AUTHOR

Rutger Vos, <rvosa@sfu.ca>

BUGS

Please report any bugs or feature requests to bug-phylo@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Phylo. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

ACKNOWLEDGEMENTS

The author would like to thank Jason Stajich for many ideas borrowed from BioPerl http://www.bioperl.org, and CIPRES http://www.phylo.org and FAB* http://www.sfu.ca/~fabstar for comments and requests.

COPYRIGHT & LICENSE

Copyright 2005 Rutger Vos, All Rights Reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.