Class: Bio::PhyloXML::Tree

Inherits:
Tree
  • Object
show all
Defined in:
lib/bio/phyloxml/elements.rb

Overview

Object to hold one phylogeny element (and its subelements.) Extended version of Bio::Tree.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Tree

Returns a new instance of Tree.



147
148
149
150
151
152
153
154
 
# File 'lib/bio/phyloxml/elements.rb', line 147

def initialize
  super
  @sequence_relations = []
  @clade_relations = []
  @confidences = []
  @properties = []
  @other = []
end

Instance Attribute Details

#branch_length_unit ⇒ Object

String.



135
136
137
 
# File 'lib/bio/phyloxml/elements.rb', line 135

def branch_length_unit
  @branch_length_unit
end

#clade_relations ⇒ Object

CladeRelation object. This is used to express a typed relationship between two clades. For example it could be used to describe multiple parents of a clade.



126
127
128
 
# File 'lib/bio/phyloxml/elements.rb', line 126

def clade_relations
  @clade_relations
end

#confidences ⇒ Object

Array of confidence object



132
133
134
 
# File 'lib/bio/phyloxml/elements.rb', line 132

def confidences
  @confidences
end

#date ⇒ Object

String. Date



141
142
143
 
# File 'lib/bio/phyloxml/elements.rb', line 141

def date
  @date
end

#description ⇒ Object

String. Description of tree.



114
115
116
 
# File 'lib/bio/phyloxml/elements.rb', line 114

def description
  @description
end

#name ⇒ Object

String. Name of tree (name subelement of phylogeny element).



108
109
110
 
# File 'lib/bio/phyloxml/elements.rb', line 108

def name
  @name
end

#other ⇒ Object

Array of Other objects. Used to save additional information from other than PhyloXML namspace.



145
146
147
 
# File 'lib/bio/phyloxml/elements.rb', line 145

def other
  @other
end

#phylogeny_id ⇒ Object

Id object.



111
112
113
 
# File 'lib/bio/phyloxml/elements.rb', line 111

def phylogeny_id
  @phylogeny_id
end

#properties ⇒ Object

Array of Property object. Allows for typed and referenced properties from external resources to be attached.



123
124
125
 
# File 'lib/bio/phyloxml/elements.rb', line 123

def properties
  @properties
end

#rerootable ⇒ Object

Boolean. Can be used to indicate that the phylogeny is not allowed to be rooted differently (i.e. because it is associated with root dependent data, such as gene duplications).



117
118
119
 
# File 'lib/bio/phyloxml/elements.rb', line 117

def rerootable
  @rerootable
end

#rooted ⇒ Object

Boolean. Required element.



120
121
122
 
# File 'lib/bio/phyloxml/elements.rb', line 120

def rooted
  @rooted
end

#sequence_relations ⇒ Object

SequenceRelation object. This is used to express a typed relationship between two sequences. For example it could be used to describe an orthology.



129
130
131
 
# File 'lib/bio/phyloxml/elements.rb', line 129

def sequence_relations
  @sequence_relations
end

#type ⇒ Object

String. Indicate the type of phylogeny (i.e. ‘gene tree’).



138
139
140
 
# File 'lib/bio/phyloxml/elements.rb', line 138

def type
  @type
end