1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
|
# Copyright (C) 2009 by Eric Talevich (eric.talevich@gmail.com)
# This code is part of the Biopython distribution and governed by its
# license. Please see the LICENSE file that should have been included
# as part of this package.
"""Unit tests for the Bio.Phylo module."""
import unittest
import zipfile
from itertools import izip
from cStringIO import StringIO
from Bio import Phylo
from Bio.Phylo import PhyloXML
# Example PhyloXML files
EX_APAF = 'PhyloXML/apaf.xml'
EX_BCL2 = 'PhyloXML/bcl_2.xml'
EX_PHYLO = 'PhyloXML/phyloxml_examples.xml'
EX_MOLLUSCA = 'PhyloXML/ncbi_taxonomy_mollusca.xml.zip'
def unzip(fname):
"""Extract a single file from a Zip archive and return a handle to it."""
assert zipfile.is_zipfile(fname)
z = zipfile.ZipFile(fname)
return StringIO(z.read(z.filelist[0].filename))
class TreeTests(unittest.TestCase):
"""Tests for methods on BaseTree.Tree objects."""
# Magic method
def test_str(self):
"""Tree.__str__: pretty-print to a string.
NB: The exact line counts are liable to change if the object
constructors change.
"""
for source, count in izip(
(EX_APAF, EX_BCL2, unzip(EX_MOLLUSCA)),
(386, 747, 16207)):
tree = Phylo.read(source, 'phyloxml')
output = str(tree)
self.assertEquals(len(output.splitlines()), count)
class MixinTests(unittest.TestCase):
"""Tests for TreeMixin methods."""
def setUp(self):
self.phylogenies = list(Phylo.parse(EX_PHYLO, 'phyloxml'))
# Traversal methods
def test_find_elements(self):
"""TreeMixin: find_elements() method."""
# From the docstring example
tree = self.phylogenies[5]
matches = list(tree.find_elements(PhyloXML.Taxonomy, code='OCTVU'))
self.assertEqual(len(matches), 1)
self.assert_(isinstance(matches[0], PhyloXML.Taxonomy))
self.assertEqual(matches[0].code, 'OCTVU')
self.assertEqual(matches[0].scientific_name, 'Octopus vulgaris')
# Iteration and regexps
tree = self.phylogenies[10]
for point, alt in izip(tree.find_elements(geodetic_datum=r'WGS\d{2}'),
(472, 10, 452)):
self.assert_(isinstance(point, PhyloXML.Point))
self.assertEqual(point.geodetic_datum, 'WGS84')
self.assertAlmostEqual(point.alt, alt)
# class filter
tree = self.phylogenies[4]
events = list(tree.find_elements(PhyloXML.Events))
self.assertEqual(len(events), 2)
self.assertEqual(events[0].speciations, 1)
self.assertEqual(events[1].duplications, 1)
# integer filter
tree = Phylo.read(EX_APAF, 'phyloxml')
domains = list(tree.find_elements(start=5))
self.assertEqual(len(domains), 8)
for dom in domains:
self.assertEqual(dom.start, 5)
self.assertEqual(dom.value, 'CARD')
def test_find_clades(self):
"""TreeMixin: find_clades() method."""
# boolean filter
for clade, name in izip(self.phylogenies[10].find_clades(name=True),
list('ABCD')):
self.assert_(isinstance(clade, PhyloXML.Clade))
self.assertEqual(clade.name, name)
# finding deeper attributes
octo = list(self.phylogenies[5].find_clades(code='OCTVU'))
self.assertEqual(len(octo), 1)
self.assert_(isinstance(octo[0], PhyloXML.Clade))
self.assertEqual(octo[0].taxonomies[0].code, 'OCTVU')
def test_find_terminal(self):
"""TreeMixin: find_elements() with terminal argument."""
for tree, total, extern, intern in izip(
self.phylogenies,
(6, 6, 7, 18, 21, 27, 7, 9, 9, 19, 15, 9, 6),
(3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4, 3, 3),
(3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3),
):
self.assertEqual(len(list(tree.find_elements())), total)
self.assertEqual(len(list(tree.find_elements(terminal=True))),
extern)
self.assertEqual(len(list(tree.find_elements(terminal=False))),
intern)
def test_get_path(self):
"""TreeMixin: get_path() method."""
path = self.phylogenies[1].get_path({'name': 'B'})
self.assertEqual(len(path), 2)
self.assertAlmostEqual(path[0].branch_length, 0.06)
self.assertAlmostEqual(path[1].branch_length, 0.23)
self.assertEqual(path[1].name, 'B')
def test_trace(self):
"""TreeMixin: trace() method."""
tree = self.phylogenies[1]
path = tree.trace({'name': 'A'}, {'name': 'C'})
self.assertEqual(len(path), 3)
self.assertAlmostEqual(path[0].branch_length, 0.06)
self.assertAlmostEqual(path[2].branch_length, 0.4)
self.assertEqual(path[2].name, 'C')
# Information methods
def test_common_ancestor(self):
"""TreeMixin: common_ancestor() method."""
tree = self.phylogenies[1]
lca = tree.common_ancestor({'name': 'A'}, {'name': 'B'})
self.assertEqual(lca, tree.clade[0])
lca = tree.common_ancestor({'name': 'A'}, {'name': 'C'})
self.assertEqual(lca, tree.clade)
tree = self.phylogenies[10]
lca = tree.common_ancestor({'name': 'A'}, {'name': 'B'}, {'name': 'C'})
self.assertEqual(lca, tree.clade[0])
def test_depths(self):
"""TreeMixin: depths() method."""
tree = self.phylogenies[1]
depths = tree.depths()
self.assertEqual(len(depths), 5)
for found, expect in zip(sorted(depths.itervalues()),
[0, 0.060, 0.162, 0.290, 0.400]):
self.assertAlmostEqual(found, expect)
def test_distance(self):
"""TreeMixin: distance() method."""
t = self.phylogenies[1]
self.assertAlmostEqual(t.distance({'name': 'A'}), 0.162)
self.assertAlmostEqual(t.distance({'name': 'B'}), 0.29)
self.assertAlmostEqual(t.distance({'name': 'C'}), 0.4)
self.assertAlmostEqual(t.distance({'name': 'A'}, {'name': 'B'}), 0.332)
self.assertAlmostEqual(t.distance({'name': 'A'}, {'name': 'C'}), 0.562)
self.assertAlmostEqual(t.distance({'name': 'B'}, {'name': 'C'}), 0.69)
def test_is_bifurcating(self):
"""TreeMixin: is_bifurcating() method."""
for tree, is_b in izip(self.phylogenies,
(1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1)):
self.assertEqual(tree.is_bifurcating(), is_b)
def test_is_monophyletic(self):
"""TreeMixin: is_monophyletic() method."""
tree = self.phylogenies[10]
abcd = tree.get_terminals()
abc = tree.clade[0].get_terminals()
ab = abc[:2]
d = tree.clade[1].get_terminals()
self.assertEqual(tree.is_monophyletic(abcd), tree.root)
self.assertEqual(tree.is_monophyletic(abc), tree.clade[0])
self.assertEqual(tree.is_monophyletic(ab), False)
self.assertEqual(tree.is_monophyletic(d), tree.clade[1])
def test_total_branch_length(self):
"""TreeMixin: total_branch_length() method."""
tree = self.phylogenies[1]
self.assertAlmostEqual(tree.total_branch_length(), 0.792)
self.assertAlmostEqual(tree.clade[0].total_branch_length(), 0.392)
# Tree manipulation methods
def test_collapse(self):
"""TreeMixin: collapse() method."""
tree = self.phylogenies[1]
parent = tree.collapse(tree.clade[0])
self.assertEqual(len(parent), 3)
for clade, name, blength in zip(parent,
('C', 'A', 'B'),
(0.4, 0.162, 0.29)):
self.assertEqual(clade.name, name)
self.assertAlmostEqual(clade.branch_length, blength)
def test_collapse_all(self):
"""TreeMixin: collapse_all() method."""
tree = Phylo.read(EX_APAF, 'phyloxml')
d1 = tree.depths()
tree.collapse_all()
d2 = tree.depths()
# Total branch lengths should not change
for clade in d2:
self.assertAlmostEqual(d1[clade], d2[clade])
# No internal nodes should remain except the root
self.assertEqual(len(tree.get_terminals()), len(tree.clade))
self.assertEqual(len(list(tree.find_clades(terminal=False))), 1)
def test_ladderize(self):
"""TreeMixin: ladderize() method."""
def ordered_names(tree):
return [n.name for n in tree.get_terminals()]
tree = self.phylogenies[10]
self.assertEqual(ordered_names(tree), list('ABCD'))
tree.ladderize()
self.assertEqual(ordered_names(tree), list('DABC'))
tree.ladderize(reverse=True)
self.assertEqual(ordered_names(tree), list('ABCD'))
def test_prune(self):
"""TreeMixin: prune() method."""
tree = self.phylogenies[10]
# Taxon in a trifurcation -- no collapse afterward
parent = tree.prune(name='B')
self.assertEqual(len(parent.clades), 2)
self.assertEqual(parent.clades[0].name, 'A')
self.assertEqual(parent.clades[1].name, 'C')
self.assertEqual(len(tree.get_terminals()), 3)
self.assertEqual(len(tree.get_nonterminals()), 2)
# Taxon in a bifurcation -- collapse
tree = self.phylogenies[0]
parent = tree.prune(name='A')
self.assertEqual(len(parent.clades), 2)
for clade, name, blen in zip(parent, 'BC', (.29, .4)):
self.assert_(clade.is_terminal())
self.assertEqual(clade.name, name)
self.assertAlmostEqual(clade.branch_length, blen)
self.assertEqual(len(tree.get_terminals()), 2)
self.assertEqual(len(tree.get_nonterminals()), 1)
# Taxon just below the root -- don't screw up
tree = self.phylogenies[1]
parent = tree.prune(name='C')
self.assertEqual(parent, tree.root)
self.assertEqual(len(parent.clades), 2)
for clade, name, blen in zip(parent, 'AB', (.102, .23)):
self.assert_(clade.is_terminal())
self.assertEqual(clade.name, name)
self.assertAlmostEqual(clade.branch_length, blen)
self.assertEqual(len(tree.get_terminals()), 2)
self.assertEqual(len(tree.get_nonterminals()), 1)
def test_split(self):
"""TreeMixin: split() method."""
tree = self.phylogenies[0]
C = tree.clade[1]
C.split()
self.assertEqual(len(C), 2)
self.assertEqual(len(tree.get_terminals()), 4)
self.assertEqual(len(tree.get_nonterminals()), 3)
C[0].split(3, .5)
self.assertEqual(len(tree.get_terminals()), 6)
self.assertEqual(len(tree.get_nonterminals()), 4)
for clade, name, blen in zip(C[0],
('C00', 'C01', 'C02'),
(0.5, 0.5, 0.5)):
self.assert_(clade.is_terminal())
self.assertEqual(clade.name, name)
self.assertEqual(clade.branch_length, blen)
# ---------------------------------------------------------
if __name__ == '__main__':
runner = unittest.TextTestRunner(verbosity=2)
unittest.main(testRunner=runner)
|