Christopher Fields > BioPerl-1.6.920 > Bio::TreeIO::nexml

Download:
BioPerl-1.6.920.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  9
Open  4
View/Report Bugs
Module Version: 1.006920   Source   Latest Release: BioPerl-1.6.924

NAME ^

Bio::TreeIO::nexml - A TreeIO driver module for parsing NeXML tree files

SYNOPSIS ^

  use Bio::TreeIO;
  my $in = Bio::TreeIO->new(-file => 'data.nexml' -format => 'Nexml');
  while( my $tree = $in->next_tree ) {
  }

DESCRIPTION ^

This is a driver module for parsing tree data in a NeXML format. For more information on NeXML, visit http://www.nexml.org.

FEEDBACK ^

Mailing Lists

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

Support

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. Many experienced and reponsive experts will be able look at the problem and quickly address it. Please include a thorough description of the problem with code and data examples if at all possible.

Reporting Bugs

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:

  https://redmine.open-bio.org/projects/bioperl/

AUTHOR - Chase Miller ^

Email chmille4@gmail.com

APPENDIX ^

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _

next_tree

 Title   : next_tree
 Usage   : my $tree = $treeio->next_tree
 Function: Gets the next tree in the stream
 Returns : L<Bio::Tree::TreeI>
 Args    : none

doc

 Title   : doc
 Usage   : $treeio->doc
 Function: Returns the biophylo nexml document object
 Returns : Bio::Phylo::Project
 Args    : none or Bio::Phylo::Project object

rewind

 Title   : rewind
 Usage   : $treeio->rewind
 Function: Resets the stream
 Returns : none
 Args    : none

write_tree

 Title   : write_tree
 Usage   : $treeio->write_tree($tree);
 Function: Writes a tree onto the stream
 Returns : none
 Args    : L<Bio::Tree::TreeI>
syntax highlighting: