newick

Documentation

Overview

Package newick handles reading and writing Newick-formatted trees.

This package uses the format described in: https://en.wikipedia.org/wiki/Newick_format

Index

• type Node
  • func (n *Node) Newick() []byte
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Read() (*Node, error)

Types

type Node

type Node struct {
	Name     string  // Node name. Can be empty.
	Distance float64 // Distance from parent. 0 is treated as none.
	Children []*Node // Child nodes. Can be nil.
}

A Node is a single node in a tree, along with the subtree that is under it.

func (*Node) Newick

func (n *Node) Newick() []byte

Newick returns a condensed Newick-format representation of this node.

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

A Reader reads Newick-formatted trees.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a Reader that reads from the given stream.

func (*Reader) Read

func (r *Reader) Read() (*Node, error)

Read reads a single tree from the input. Can be called multiple times to read subsequent trees.