tree

Documentation

Overview

Package tree provides a struct and functions that allow for creating binary trees modifying them, and doing calculations on them.

Index

• func Draw(node *Tree, imageWidth int, imageHeight int) (*image.RGBA, error)
• func Height(node *Tree) float64
• func ToString(node *Tree) string
• func WriteNewick(filename string, node *Tree)
• type Tree
  • func ParseDot(input string, verbose bool) *Tree
  • func ParseNewick(input string) (*Tree, error)
  • func ReadNewick(filename string) (*Tree, error)

Functions

func Draw

func Draw(node *Tree, imageWidth int, imageHeight int) (*image.RGBA, error)

Draw prints a tree to as an image. The function takes a pointer to the root of the tree along with the desired height and width of the output image.

func Height

func Height(node *Tree) float64

Height returns the maximum cumulative branch length from the input tree node to a leaf node.

func ToString

func ToString(node *Tree) string

ToString takes a pointer to the root of a tree and returns that tree as a text representation of the tree in newick format.

func WriteNewick

func WriteNewick(filename string, node *Tree)

WriteNewick takes a filename and a pointer to the root of a tree. It writes the tree to the file in newick format.

Types

type Tree

type Tree struct {
	Name         string
	OnlyTopology bool
	BranchLength float64
	Left         *Tree
	Right        *Tree
}

A Tree is a node in a binary tree

func ParseDot

func ParseDot(input string, verbose bool) *Tree

ParseDot takes in the filename of a filename of a tree in "dot" format and a verbose flag that can be used to print debugging info. ParseDot returns a pointer to the root node of the tree.

func ParseNewick

func ParseNewick(input string) (*Tree, error)

ParseNewick takes a newick tree as an input string and returns a pointer to the root of the tree.

func ReadNewick

func ReadNewick(filename string) (*Tree, error)

ReadNewick takes a filename of a newick tree as input and returns a pointer to the root of the tree.