Documentation
¶
Overview ¶
Package newick provides facilities for reading and writing trees in the Newick format. The format used is roughly equivalent to the conventions established here: http://evolution.genetics.washington.edu/phylip/newick_doc.html. Although, comments and quoted labels are not (yet) implemented.
An informal description of the Newick format can be found here: http://evolution.genetics.washington.edu/phylip/newicktree.html.
Currently, this package only includes a reader, but a writer will be added as needed.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader corresponds to the state necessary to read trees from Newick formatted input.
type Tree ¶
type Tree struct {
// All children of this node, which may be empty.
Children []Tree
// The label of this node. If it's empty, then this node does
// not have a name.
Label string
// The branch length of this node corresponding to the distance between
// it and its parent node. If it's `nil`, then no distance exists.
Length *float64
}
Tree corresponds to any value representable in a Newick format. Each tree value corresponds to a single node.
Source Files