NAME

Bio::Phylo::Unparsers - A library for stringifying phylogenetic data files and strings

SYNOPSIS

my $unparser = new Bio::Phylo::Unparsers;
print $unparser->unparse(-phylo => $tree, -format => 'newick');

DESCRIPTION

The Unparsers module is the unified front end for unparsing tree objects. The module imports the appropriate sub-module at runtime, depending on the '-format' argument.

CONSTRUCTOR

new()

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

unparse(%options)

The unparse method is the front door for the various unparser modules. All argument checking should be done here, not by the individual unparsers. At this point, the assumption is that all (valid) unparsers can do a to_string method, but conceivably this should be extended to include to_file methods, and possibly to_database.

Type    : Parsers
Title   : unparse(%options)
Usage   : $unparser->unparse(%options);
Function: Turns Bio::Phylo object into a string according to specified format.
Returns : SCALAR
Args    : -phylo => (Bio::Phylo object),
          -format => (description format),
          -other => (parser specific options)

AUTHOR

Rutger Vos, <rvosa@sfu.ca> http://www.sfu.ca/~rvosa/

BUGS

Please report any bugs or feature requests to bug-bio-phylo@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bio-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.