class Bio::Newick

Newick standard phylogenetic tree parser class.

This is alpha version. Incompatible changes may be made frequently.

Constants

DELIMITER

delemiter of the entry

Edge

same as Bio::Tree::Edge

Node

same as Bio::Tree::Node

Attributes

entry_overrun[R]

string after this entry

options[R]

parser options (in some cases, options can be automatically set by the parser)

original_string[R]

original string before parsing

Public Class Methods

new(str, options = nil) click to toggle source

Creates a new Newick object. options for parsing can be set.

Available options:

:bootstrap_style

:traditional for traditional bootstrap style, :molphy for molphy style, :disabled to ignore bootstrap strings. For details of default actions, please read the notes below.

:parser

:naive for using naive parser, compatible with BioRuby 1.1.0, which ignores quoted strings and do not convert underscores to spaces.

Notes for bootstrap style: Molphy-style bootstrap values may always be parsed, even if the options[:bootstrap_style] is set to :traditional or :disabled.

Note for default or traditional bootstrap style: By default, if all of the internal node's names are numeric and there are no NHX and no molphy-style boostrap values, the names of internal nodes are regarded as bootstrap values. options[:bootstrap_style] = :disabled or :molphy to disable the feature (or at least one NHX tag exists).

# File lib/bio/db/newick.rb, line 71
def initialize(str, options = nil)
  str = str.sub(/\;(.*)/m, ';')
  @original_string = str
  @entry_overrun = $1
  @options = (options or {})
end

Public Instance Methods

reparse() click to toggle source

Re-parses the tree from the original string. Returns self. This method is useful after changing parser options.

# File lib/bio/db/newick.rb, line 101
def reparse
  if defined?(@tree)
    remove_instance_variable(:@tree)
  end
  self.tree
  self
end
tree() click to toggle source

Gets the tree. Returns a Bio::Tree object.

# File lib/bio/db/newick.rb, line 90
def tree
  if !defined?(@tree)
    @tree = __parse_newick(@original_string, @options)
  else
    @tree
  end
end