File: test_datamodel_tree_taxon_management.py

package info (click to toggle)
python-dendropy 4.2.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 68,392 kB
  • ctags: 3,947
  • sloc: python: 41,840; xml: 1,400; makefile: 15
file content (460 lines) | stat: -rw-r--r-- 20,148 bytes parent folder | download | duplicates (2)
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
#! /usr/bin/env python

##############################################################################
##  DendroPy Phylogenetic Computing Library.
##
##  Copyright 2010-2015 Jeet Sukumaran and Mark T. Holder.
##  All rights reserved.
##
##  See "LICENSE.rst" for terms and conditions of usage.
##
##  If you use this work or any portion thereof in published work,
##  please cite it as:
##
##     Sukumaran, J. and M. T. Holder. 2010. DendroPy: a Python library
##     for phylogenetic computing. Bioinformatics 26: 1569-1571.
##
##############################################################################

"""
Tests Tree taxon management
"""

import os
import unittest
import dendropy
import collections
import copy
from dendropy.test.support import curated_test_tree
from dendropy.test.support import compare_and_validate
from dendropy.test.support import dendropytest

class TestTreeUpdateTaxonNamespace(
        curated_test_tree.CuratedTestTree,
        dendropytest.ExtendedTestCase):

    def setUp(self):
        self.tree1, self.anodes1, self.lnodes1, self.inodes1 = self.get_tree(
                suppress_internal_node_taxa=True,
                suppress_leaf_node_taxa=True)
        self.expected_labels = set([nd.label for nd in self.anodes1 if nd.label is not None])
        self.expected_taxa = set()
        for nd in self.tree1:
            if nd.label is not None:
                nd.taxon = dendropy.Taxon(label=nd.label)
                self.expected_taxa.add(nd.taxon)
        assert len(self.expected_labels) == len(self.anodes1)
        assert len(self.expected_taxa) == len(self.expected_labels)

    def test_noop_update_with_no_taxa(self):
        tree, anodes, lnodes, inodes = self.get_tree(
                suppress_internal_node_taxa=True,
                suppress_leaf_node_taxa=True)
        original_tns = tree.taxon_namespace
        self.assertEqual(len(original_tns), 0)
        tree.update_taxon_namespace()
        self.assertIs(tree.taxon_namespace, original_tns)
        self.assertEqual(len(original_tns), 0)

    def test_noop_update(self):
        tree, anodes, lnodes, inodes = self.get_tree(
                suppress_internal_node_taxa=False,
                suppress_leaf_node_taxa=False)
        original_tns = tree.taxon_namespace
        original_taxa = [t for t in original_tns]
        original_labels = [t.label for t in original_tns]
        tree.update_taxon_namespace()
        self.assertIs(tree.taxon_namespace, original_tns)
        new_taxa = [t for t in original_tns]
        new_labels = [t.label for t in original_tns]
        self.assertEqual(new_taxa, original_taxa)
        self.assertEqual(new_labels, original_labels)

    def test_update_taxon_namespace(self):
        tns1 = self.tree1.taxon_namespace
        self.assertEqual(len(tns1), 0)
        tns2 = self.tree1.update_taxon_namespace()
        self.assertIs(self.tree1.taxon_namespace, tns1)
        self.assertEqual(set(tns2._taxa), self.expected_taxa)
        self.assertEqual(len(tns2._taxa), len(self.expected_labels))

class TestTreeMigrateAndReconstructTaxonNamespace(
        curated_test_tree.CuratedTestTree,
        dendropytest.ExtendedTestCase):

    def setUp(self):
        self.tree, self.anodes, self.lnodes, self.inodes = self.get_tree(
                suppress_internal_node_taxa=True,
                suppress_leaf_node_taxa=True)
        self.node_label_to_taxon_label_map = {
            "a" : "a",
            "b" : "a",
            "c" : "2",
            "e" : "2",
            "f" : "b",
            "g" : "B",
            "h" : "B",
            "i" : "h",
            "j" : "H",
            "k" : "h",
            "l" : None,
            "m" : None,
            "n" : "H",
            "o" : "J",
            "p" : "j",
                }
        self.original_taxa = []
        for idx, nd in enumerate(self.tree):
            taxon_label = self.node_label_to_taxon_label_map[nd.label]
            t = dendropy.Taxon(label=taxon_label)
            self.tree.taxon_namespace.add_taxon(t)
            nd.taxon = t
            nd.original_taxon = t
            self.original_taxa.append(t)
        assert len(self.tree.taxon_namespace) == len(self.node_label_to_taxon_label_map)
        assert len(self.tree.taxon_namespace) == len(self.original_taxa)

    def create_redundant_taxa(self):
        nodes_to_unify_taxa = []
        for nd in self.tree:
            if nd.taxon.label and nd.taxon.label.upper() == "J":
                nodes_to_unify_taxa.append(nd)
        assert len(nodes_to_unify_taxa) >= 2
        utaxon = nodes_to_unify_taxa[0].taxon
        utaxon.node_label = nodes_to_unify_taxa[0].label
        for nd in nodes_to_unify_taxa[1:]:
            self.tree.taxon_namespace.remove_taxon(nd.taxon)
            self.original_taxa.remove(nd.taxon)
            nd.original_taxon = utaxon
            nd.taxon = utaxon
            del self.node_label_to_taxon_label_map[nd.label]
            nd.label = utaxon.node_label

    def verify_taxon_namespace_reconstruction(self,
            unify_taxa_by_label=False,
            case_sensitive_label_mapping=True,
            original_tns=None,
            redundant_taxa=False):
        seen_taxa = []
        if unify_taxa_by_label:
            if not case_sensitive_label_mapping:
                expected_labels = []
                for label in self.node_label_to_taxon_label_map.values():
                    if label is None:
                        expected_labels.append(label)
                    else:
                        label = label.upper()
                        if label not in expected_labels:
                            expected_labels.append(label)
            else:
                expected_labels = list(set(label for label in self.node_label_to_taxon_label_map.values()))
        else:
            expected_labels = [label for label in self.node_label_to_taxon_label_map.values()]
        for nd in self.tree:
            self.assertIsNot(nd.taxon, nd.original_taxon)
            if (not case_sensitive_label_mapping) and nd.taxon.label is not None:
                self.assertEqual(nd.taxon.label.upper(), nd.original_taxon.label.upper())
                self.assertEqual(self.node_label_to_taxon_label_map[nd.label].upper(), nd.taxon.label.upper())
            else:
                self.assertEqual(nd.taxon.label, nd.original_taxon.label)
                self.assertEqual(self.node_label_to_taxon_label_map[nd.label], nd.taxon.label)
            self.assertNotIn(nd.original_taxon, self.tree.taxon_namespace)
            self.assertIn(nd.original_taxon, self.original_taxa)
            self.assertIn(nd.taxon, self.tree.taxon_namespace)
            self.assertNotIn(nd.taxon, self.original_taxa)
            if original_tns is not None:
                self.assertNotIn(nd.taxon, original_tns)
            if nd.taxon not in seen_taxa:
                seen_taxa.append(nd.taxon)
            else:
                self.assertTrue(unify_taxa_by_label or redundant_taxa)
                if not case_sensitive_label_mapping:
                    self.assertIn(nd.taxon.label, [t.label for t in seen_taxa])
                else:
                    if nd.taxon.label is None:
                        self.assertIs(nd.original_taxon.label, None)
                        self.assertEqual([t.label for t in seen_taxa].count(None), 1)
                    else:
                        x1 = [t.label.upper() for t in seen_taxa if t.label is not None]
                        self.assertIn(nd.taxon.label.upper(), x1)
        self.assertEqual(len(self.tree.taxon_namespace), len(expected_labels))
        if not unify_taxa_by_label and not redundant_taxa:
            self.assertEqual(len(self.tree.taxon_namespace), len(self.node_label_to_taxon_label_map))
        self.assertEqual(len(seen_taxa), len(self.tree.taxon_namespace))
        if not case_sensitive_label_mapping:
            seen_labels = [(t.label.upper() if t.label is not None else None) for t in seen_taxa]
        else:
            seen_labels = [t.label for t in seen_taxa]
        c1 = collections.Counter(expected_labels)
        c2 = collections.Counter(seen_labels)
        self.assertEqual(c1, c2)

    def test_noop_taxon_namespace_reconstruction(self):
        tree, anodes, lnodes, inodes = self.get_tree(
                suppress_internal_node_taxa=False,
                suppress_leaf_node_taxa=False)
        original_tns = tree.taxon_namespace
        original_tns.is_case_sensitive = True
        original_taxa = [t for t in original_tns]
        original_labels = [t.label for t in original_tns]
        tree.reconstruct_taxon_namespace(
                unify_taxa_by_label=False)
        self.assertIs(tree.taxon_namespace, original_tns)
        new_taxa = [t for t in original_tns]
        new_labels = [t.label for t in original_tns]
        self.assertEqual(new_taxa, original_taxa)
        self.assertEqual(new_labels, original_labels)

    def test_reconstruct_taxon_namespace_non_unifying(self):
        original_tns = self.tree.taxon_namespace
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = True
        self.tree._taxon_namespace = new_tns
        self.assertEqual(len(self.tree.taxon_namespace), 0)
        self.tree.reconstruct_taxon_namespace(unify_taxa_by_label=False)
        self.assertIsNot(self.tree.taxon_namespace, original_tns)
        self.assertIs(self.tree.taxon_namespace, new_tns)
        self.verify_taxon_namespace_reconstruction(
                unify_taxa_by_label=False,
                case_sensitive_label_mapping=True)

    def test_reconstruct_taxon_namespace_unifying_case_sensitive(self):
        original_tns = self.tree.taxon_namespace
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = True
        self.tree._taxon_namespace = new_tns
        self.assertEqual(len(self.tree.taxon_namespace), 0)
        self.tree.reconstruct_taxon_namespace(unify_taxa_by_label=True)
        self.assertIsNot(self.tree.taxon_namespace, original_tns)
        self.assertIs(self.tree.taxon_namespace, new_tns)
        self.verify_taxon_namespace_reconstruction(
                unify_taxa_by_label=True,
                case_sensitive_label_mapping=True,
                original_tns=original_tns)

    def test_reconstruct_taxon_namespace_unifying_case_insensitive(self):
        original_tns = self.tree.taxon_namespace
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = False
        self.tree._taxon_namespace = new_tns
        self.assertEqual(len(self.tree.taxon_namespace), 0)
        self.tree.reconstruct_taxon_namespace(unify_taxa_by_label=True)
        self.assertIsNot(self.tree.taxon_namespace, original_tns)
        self.assertIs(self.tree.taxon_namespace, new_tns)
        self.verify_taxon_namespace_reconstruction(
                unify_taxa_by_label=True,
                case_sensitive_label_mapping=False,
                original_tns=original_tns)

    def test_reconstruct_taxon_namespace_with_redundant_taxa(self):
        for (unify, ci) in [
                (False, True),
                (True, True),
                (True, False), ]:
            self.setUp()
            self.create_redundant_taxa()
            original_tns = self.tree.taxon_namespace
            new_tns = dendropy.TaxonNamespace()
            new_tns.is_case_sensitive = ci
            self.tree._taxon_namespace = new_tns
            self.assertEqual(len(self.tree.taxon_namespace), 0)
            self.tree.reconstruct_taxon_namespace(unify_taxa_by_label=unify)
            self.assertIsNot(self.tree.taxon_namespace, original_tns)
            self.assertIs(self.tree.taxon_namespace, new_tns)
            self.verify_taxon_namespace_reconstruction(
                    unify_taxa_by_label=unify,
                    case_sensitive_label_mapping=ci,
                    original_tns=original_tns,
                    redundant_taxa=True)

    def test_reconstruct_taxon_namespace_mapping(self):
        for (unify, ci) in [
                (False, False),
                (True, False),
                (True, True), ]:
            self.setUp()
            original_tns = self.tree.taxon_namespace
            new_tns = dendropy.TaxonNamespace()
            new_tns.is_case_sensitive = ci
            self.tree._taxon_namespace = new_tns
            self.assertEqual(len(self.tree.taxon_namespace), 0)
            memo = {}
            for taxon in self.original_taxa:
                memo[taxon] = dendropy.Taxon()
            memo_copy = dict(memo)
            self.tree.reconstruct_taxon_namespace(
                    unify_taxa_by_label=unify,
                    taxon_mapping_memo=memo)
            self.assertIsNot(self.tree.taxon_namespace, original_tns)
            self.assertIs(self.tree.taxon_namespace, new_tns)
            for nd in self.tree:
                self.assertIs(nd.taxon, memo_copy[nd.original_taxon])

    def test_noop_migrate_taxon_namespace(self):
        tree, anodes, lnodes, inodes = self.get_tree(
                suppress_internal_node_taxa=False,
                suppress_leaf_node_taxa=False)
        original_tns = tree.taxon_namespace
        original_tns.is_case_sensitive = True
        original_taxa = [t for t in original_tns]
        original_labels = [t.label for t in original_tns]
        tree.migrate_taxon_namespace(
                original_tns,
                unify_taxa_by_label=False)
        self.assertIs(tree.taxon_namespace, original_tns)
        new_taxa = [t for t in original_tns]
        new_labels = [t.label for t in original_tns]
        self.assertEqual(new_taxa, original_taxa)
        self.assertEqual(new_labels, original_labels)

    def test_simple_migrate_taxon_namespace(self):
        tree, anodes, lnodes, inodes = self.get_tree(
                suppress_internal_node_taxa=True,
                suppress_leaf_node_taxa=True)
        original_tns = tree.taxon_namespace
        original_taxa = [t for t in original_tns]
        original_labels = [t.label for t in original_tns]
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = True
        tree.migrate_taxon_namespace(
                new_tns,
                unify_taxa_by_label=False)
        self.assertIsNot(tree.taxon_namespace, original_tns)
        self.assertIs(tree.taxon_namespace, new_tns)
        new_taxa = [t for t in new_tns]
        self.assertEqual(len(new_taxa), len(original_taxa))
        for t1, t2 in zip(new_taxa, original_taxa):
            self.assertIsNot(t1, t2)
            self.assertEqual(t1.label, t2.label)

    def test_migrate_taxon_namespace_non_unifying(self):
        original_tns = self.tree.taxon_namespace
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = True
        self.tree.migrate_taxon_namespace(
                new_tns,
                unify_taxa_by_label=False)
        self.assertIsNot(self.tree.taxon_namespace, original_tns)
        self.assertIs(self.tree.taxon_namespace, new_tns)
        self.verify_taxon_namespace_reconstruction(
                unify_taxa_by_label=False,
                case_sensitive_label_mapping=True,
                original_tns=original_tns)

    def test_migrate_taxon_namespace_unifying_case_sensitive(self):
        original_tns = self.tree.taxon_namespace
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = True
        self.tree.migrate_taxon_namespace(
                new_tns,
                unify_taxa_by_label=True)
        self.assertIsNot(self.tree.taxon_namespace, original_tns)
        self.assertIs(self.tree.taxon_namespace, new_tns)
        self.verify_taxon_namespace_reconstruction(
                unify_taxa_by_label=True,
                case_sensitive_label_mapping=True,
                original_tns=original_tns)

    def test_migrate_taxon_namespace_unifying_case_insensitive(self):
        original_tns = self.tree.taxon_namespace
        new_tns = dendropy.TaxonNamespace()
        new_tns.is_case_sensitive = False
        self.tree.migrate_taxon_namespace(
                new_tns,
                unify_taxa_by_label=True)
        self.assertIsNot(self.tree.taxon_namespace, original_tns)
        self.assertIs(self.tree.taxon_namespace, new_tns)
        self.verify_taxon_namespace_reconstruction(
                unify_taxa_by_label=True,
                case_sensitive_label_mapping=False,
                original_tns=original_tns)

    def test_migrate_taxon_namespace_mapping(self):
        for (unify, ci) in [
                (False, True),
                (True, True),
                (True, False), ]:
            self.setUp()
            original_tns = self.tree.taxon_namespace
            new_tns = dendropy.TaxonNamespace()
            new_tns.is_case_sensitive = ci
            memo = {}
            for taxon in self.original_taxa:
                memo[taxon] = dendropy.Taxon()
            memo_copy = dict(memo)
            self.tree.migrate_taxon_namespace(
                    new_tns,
                    unify_taxa_by_label=unify,
                    taxon_mapping_memo=memo)
            self.assertIsNot(self.tree.taxon_namespace, original_tns)
            self.assertIs(self.tree.taxon_namespace, new_tns)
            for nd in self.tree:
                self.assertIs(nd.taxon, memo_copy[nd.original_taxon])

    def test_migrate_taxon_namespace_with_redundant_taxa(self):
        for (unify, ci) in [
                (False, True),
                (True, True),
                (True, False), ]:
            self.setUp()
            self.create_redundant_taxa()
            original_tns = self.tree.taxon_namespace
            new_tns = dendropy.TaxonNamespace()
            new_tns.is_case_sensitive = ci
            self.tree.migrate_taxon_namespace(
                    new_tns,
                    unify_taxa_by_label=unify)
            self.assertIsNot(self.tree.taxon_namespace, original_tns)
            self.assertIs(self.tree.taxon_namespace, new_tns)
            self.verify_taxon_namespace_reconstruction(
                    unify_taxa_by_label=unify,
                    case_sensitive_label_mapping=ci,
                    original_tns=original_tns,
                    redundant_taxa=True)

    def test_unassign_taxa(self):
        self.assertFalse(self.fail_incomplete_tests())

    def test_randomly_assign_taxa(self):
        self.assertFalse(self.fail_incomplete_tests())

class TestTreeTaxa(
        curated_test_tree.CuratedTestTree,
        dendropytest.ExtendedTestCase):

    def setUp(self):
        self.tree1, self.anodes1, self.lnodes1, self.inodes1 = self.get_tree(
                suppress_internal_node_taxa=False,
                suppress_leaf_node_taxa=False)
        self.expected_taxa = set([nd.taxon for nd in self.anodes1 if nd.taxon is not None])

    def test_basic_taxa(self):
        self.assertEqual(self.tree1.poll_taxa(), self.expected_taxa)

class TestTreePurgeTaxonNamespace(
        curated_test_tree.CuratedTestTree,
        dendropytest.ExtendedTestCase):

    def setUp(self):
        self.tree1, self.anodes1, self.lnodes1, self.inodes1 = self.get_tree(
                suppress_internal_node_taxa=False,
                suppress_leaf_node_taxa=False)
        self.expected_taxa = set([nd.taxon for nd in self.anodes1 if nd.taxon is not None])

    def test_noop_purge(self):
        self.assertEqual(set(self.tree1.taxon_namespace), self.expected_taxa)
        self.tree1.purge_taxon_namespace()
        self.assertEqual(set(self.tree1.taxon_namespace), self.expected_taxa)

    def test_basic_purge(self):
        self.assertEqual(set(self.tree1.taxon_namespace), self.expected_taxa)
        added_taxa = set(self.expected_taxa)
        for label in ("z1", "z2", "z3", "z4"):
            t = self.tree1.taxon_namespace.new_taxon(label=label)
            added_taxa.add(t)
        self.assertEqual(set(self.tree1.taxon_namespace), added_taxa)
        self.tree1.purge_taxon_namespace()
        self.assertEqual(set(self.tree1.taxon_namespace), self.expected_taxa)

if __name__ == "__main__":
    unittest.main()