Back to index

python-biopython  1.60
Classes | Functions | Variables
Bio.Phylo.NewickIO Namespace Reference

Classes

class  NewickError
class  Parser
class  Writer

Functions

def parse
def write

Variables

string __docformat__ = "restructuredtext en"
string NODECOMMENT_START = '[&'
string NODECOMMENT_END = ']'

Class Documentation

class Bio::Phylo::NewickIO::NewickError
Exception raised when Newick object construction cannot continue.

Definition at line 26 of file NewickIO.py.


Function Documentation

def Bio.Phylo.NewickIO.parse (   handle,
  kwargs 
)
Iterate over the trees in a Newick file handle.

:returns: generator of Bio.Phylo.Newick.Tree objects.

Definition at line 34 of file NewickIO.py.

00034 
00035 def parse(handle, **kwargs):
00036     """Iterate over the trees in a Newick file handle.
00037 
00038     :returns: generator of Bio.Phylo.Newick.Tree objects.
00039     """
00040     return Parser(handle).parse(**kwargs)

def Bio.Phylo.NewickIO.write (   trees,
  handle,
  plain = False,
  kwargs 
)
Write a trees in Newick format to the given file handle.

:returns: number of trees written.

Definition at line 41 of file NewickIO.py.

00041 
00042 def write(trees, handle, plain=False, **kwargs):
00043     """Write a trees in Newick format to the given file handle.
00044 
00045     :returns: number of trees written.
00046     """
00047     return Writer(trees).write(handle, plain=plain, **kwargs)
00048 
00049 
00050 # ---------------------------------------------------------
00051 # Input


Variable Documentation

string Bio.Phylo.NewickIO.__docformat__ = "restructuredtext en"

Definition at line 12 of file NewickIO.py.

Definition at line 23 of file NewickIO.py.

Definition at line 22 of file NewickIO.py.