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
|
# Copyright 2009 by David Winter. All rights reserved.
# 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.
import os
import sys
import unittest
import subprocess
from Bio import MissingExternalDependencyError
from Bio import AlignIO
from Bio.Nexus import Trees # One day we should use planned TreeIO module
from Bio.Emboss.Applications import FDNADistCommandline, FNeighborCommandline
from Bio.Emboss.Applications import FSeqBootCommandline, FProtDistCommandline
from Bio.Emboss.Applications import FProtParsCommandline, FConsenseCommandline
from Bio.Emboss.Applications import FTreeDistCommandline, FDNAParsCommandline
exes_wanted = ['fdnadist', 'fneighbor', 'fprotdist','fprotpars','fconsense',
'fseqboot', 'ftreedist', 'fdnapars']
exes = dict() #Dictionary mapping from names to exe locations
# Windows bit not tested (but copied from test_Emboss so should work)
if sys.platform=="win32":
#The default installation path is C:\mEMBOSS which contains the exes.
#EMBOSS also sets an environment variable which we will check for.
try:
path = os.environ["EMBOSS_ROOT"]
except KeyError:
#print >> sys.stderr, "Missing EMBOSS_ROOT environment variable!"
raise MissingExternalDependencyError(\
"Install the Emboss package 'Phylip New' if you want to use the "+\
"Bio.Emboss.Applications wrappers for phylogenetic tools")
if os.path.isdir(path):
for name in exes_wanted:
if os.path.isfile(os.path.join(path, name+".exe")):
exes[name] = os.path.join(path, name+".exe")
del path, name
else:
import commands
for name in exes_wanted:
#This will "just work" if installed on the path as normal on Unix
if "not found" not in commands.getoutput("%s -help" % name):
exes[name] = name
del name
if len(exes) < len(exes_wanted):
raise MissingExternalDependencyError(\
"Install the Emboss package 'PhylipNew' if you want to use the "+\
"Bio.Emboss.Applications wrappers for phylogenetic tools.")
###########################################################################
# A few top level functions that are called repeatedly in the test cases
def run_command(cline):
""" Run a given commandline using subprocess"""
return subprocess.call(str(cline),
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
shell=(sys.platform!="win32"))
def write_AlignIO_dna():
""" Convert opuntia.aln to a phylip file """
dna = AlignIO.parse(open("Clustalw/opuntia.aln", "r"), "clustal")
AlignIO.write(dna, open("Phylip/opuntia.phy", "w"), "phylip")
def write_AlignIO_protein():
""" Conver hedgehog.aln to a phylip file"""
protein = AlignIO.parse(open("Clustalw/hedgehog.aln", "r"), "clustal")
AlignIO.write(protein, open("Phylip/hedgehog.phy", "w"), "phylip")
def clean_up():
""" Delete tests files (to be used as tearDown() function in test fixtures)"""
for filename in ["test_file", "Phylip/opuntia.phy","Phylip/hedgehog.phy"]:
if os.path.isfile(filename):
os.remove(filename)
def parse_trees(filename):
"""Helper function until we have Bio.TreeIO on trunk."""
data = open("test_file", "r").read()
for tree_str in data.split(";\n"):
if tree_str:
yield Trees.Tree(tree_str+";")
class DistanceTests(unittest.TestCase):
""" Tests for calculating distance based phylogenetic trees with phylip """
def tearDown(self):
clean_up()
test_taxa = ['Archaeohip', 'Calippus', 'Hypohippus', 'M._secundu',
'Merychippu', 'Mesohippus', 'Nannipus', 'Neohippari',
'Parahippus', 'Pliohippus']
def distances_from_alignment(self, filename, DNA = True):
""" check we can make distance matrix from a given alignment """
self.assert_(os.path.isfile(filename), "Missing %s" % filename)
if DNA:
cline = FDNADistCommandline(exes["fdnadist"],
method = 'j',
sequence= filename,
outfile = "test_file",
auto = True)
else:
cline = FProtDistCommandline(exes["fprotdist"],
method = 'j',
sequence= filename,
outfile = "test_file",
auto = True)
return_code = run_command(cline)
if return_code != 0:
raise ValueError("Return code %s from:\n%s" \
% (return_code, str(cline)))
#biopython can't grok distance matrices, so we'll just check it exists
self.assert_(os.path.isfile("test_file"))
def tree_from_distances(self, filename):
""" Check we can estimate a tree from a distance matrix """
self.assert_(os.path.isfile(filename), "Missing %s" % filename)
cline = FNeighborCommandline(exes["fneighbor"],
datafile = filename,
outtreefile = "test_file",
auto= True, filter = True)
return_code = run_command(cline)
if return_code != 0:
raise ValueError("Return code %s from:\n%s" % (return_code, str(cline)))
for tree in parse_trees("test_file"):
tree_taxa = [t.replace(" ", "_") for t in tree.get_taxa()]
self.assertEqual(self.test_taxa, sorted(tree_taxa))
def test_distances_from_phylip_DNA(self):
"""Calculate a distance matrix from an phylip alignment """
self.distances_from_alignment("Phylip/horses.phy")
def test_distances_from_AlignIO_DNA(self):
"""Calculate a distance matrix from an alignment written by AlignIO"""
write_AlignIO_dna()
self.distances_from_alignment("Phylip/opuntia.phy")
#def test_distances_from_bootstrapped_phylip_DNA(self):
# """ Calculate a set of distance matrices from phylip alignments """
# self.distances_from_alignment("Phylip/bs_horses.phy")
# fprotdist tests
def test_distances_from_protein_phylip(self):
""" Calculate a distance matrix from phylip protein alignment"""
self.distances_from_alignment("Phylip/interlaced.phy", DNA=False)
def test_distances_from_protein_AlignIO(self):
"""Calculate distance matrix from an AlignIO written protein alignment"""
write_AlignIO_protein()
self.distances_from_alignment("Phylip/hedgehog.phy", DNA=False)
#def test_distances_from_bootstrapped_phylip_protein(self):
# """Calculate distance matrices from a bootstrapped protein alignment"""
# self.distances_from_alignment("Clustalw/bs_interlaced.phy", DNA=False)
# fneighbor tests
#def test_tree_from_distances(self):
# """Estimate tree from distance matrix and parse it."""
# self.tree_from_distances("Phylip/horses.fdnadist")
# This one won't work because of a bug in EMBOSS 6.0.1
#def test_tree_from_bootstrapped_distances(self):
#"""Estimate tree from bootstrapped distance matrix and parse it """
##self.tree_from_distances("Phylip/bs_horses.fdnadist")
class ParsimonyTests(unittest.TestCase):
""" Tests for estimating parsimony based phylogenetic trees with phylip"""
def tearDown(self):
clean_up()
def parsimony_tree(self, filename, format, DNA=True):
""" estimate a parsimony tree from an alignment """
self.assert_(os.path.isfile(filename), "Missing %s" % filename)
if DNA:
cline = FDNAParsCommandline(exes["fdnapars"],
sequence = filename,
outtreefile = "test_file",
auto= True, stdout=True)
else:
cline = FProtParsCommandline(exes["fprotpars"],
sequence = filename,
outtreefile = "test_file",
auto= True, stdout=True)
return_code = run_command(cline)
if return_code != 0:
raise ValueError("Return code %s from:\n%s" \
% (return_code, str(cline)))
a_taxa = [s.name.replace(" ", "_") for s in
AlignIO.parse(open(filename, "r"), format).next()]
for tree in parse_trees("test_file"):
t_taxa = [t.replace(" ", "_") for t in tree.get_taxa()]
self.assertEqual(sorted(a_taxa), sorted(t_taxa))
# fdnapars tests
#def test_parsimony_tree_from_phylip_DNA(self):
# """ Make a parsimony tree from a phylip DNA alignment """
# self.parsimony_tree("Phylip/horses.phy", "phylip")
def test_parsimony_tree_from_AlignIO_DNA(self):
""" Make a parsimony tree from an alignment written with AlignIO"""
write_AlignIO_dna()
self.parsimony_tree("Phylip/opuntia.phy", "phylip")
#def test_parsimony_bootstrapped_phylip_DNA(self):
# """ make a parsimony tree from a bootstrapped phylip DNA alignment """
# self.parsimony_tree("Phylip/bs_horses.phy", "phylip")
# fprotpars tests
#def test_parsimony_tree_from_phylip_protein(self):
# """ Make a parsimony tree from a phylip DNA alignment """
# self.parsimony_tree("Phylip/interlaced.phy", "phylip", DNA=False)
def test_parsimony_from_AlignIO_protein(self):
"""Make a parsimony tree from protein alignment written with AlignIO"""
write_AlignIO_protein()
self.parsimony_tree("Phylip/interlaced.phy", "phylip", DNA=False)
#def test_parsimony_tree_bootstrapped_phylip_protein(self):
# """ Make a parsimony tree from a phylip DNA alignment"""
# self.parsimony_tree("Phylip/bs_interlaced.phy", "phylip", DNA=False)
class BootstrapTests(unittest.TestCase):
""" Tests for pseudosampling alignments with fseqboot"""
def tearDown(self):
clean_up()
def check_bootstrap(self, filename, format, align_type="d"):
""" check we can use fseqboot to pseudosample an alignment
The align_type type argument is passed to the commandline object to
set the output format to use (from [D]na,[p]rotein and [r]na )
"""
self.assert_(os.path.isfile(filename), "Missing %s" % filename)
cline = FSeqBootCommandline(exes["fseqboot"],
sequence = filename,
outfile = "test_file",
seqtype = align_type,
reps = 2,
auto = True, filter = True)
return_code = run_command(cline)
if return_code != 0:
raise ValueError("Return code %s from:\n%s" \
% (return_code, str(cline)))
# the resultant file should have 2 alignments...
bs = list(AlignIO.parse(open("test_file", "r" ), format))
self.assertEqual(len(bs), 2)
# ..and each name in the original alignment...
a_names = [s.name.replace(" ", "_") for s in
AlignIO.read(open(filename, "r"), format)]
# ...should be in each alignment in the bootstrapped file
for a in bs:
self.assertEqual(a_names, [s.name.replace(" ", "_") for s in a])
def test_bootstrap_phylip_DNA(self):
""" pseudosample a phylip DNA alignment """
self.check_bootstrap("Phylip/horses.phy", "phylip")
def test_bootstrap_AlignIO_DNA(self):
""" pseudosample a phylip DNA alignment written with AlignIO """
write_AlignIO_dna()
self.check_bootstrap("Phylip/opuntia.phy", "phylip")
def test_bootstrap_phylip_protein(self):
""" pseudosample a phylip protein alignment """
self.check_bootstrap("Phylip/interlaced.phy", "phylip", "p")
def test_bootstrap_AlignIO_protein(self):
""" pseudosample a phylip protein alignment written with AlignIO """
write_AlignIO_protein()
self.check_bootstrap("Phylip/hedgehog.phy", "phylip", "p")
class TreeComparisonTests(unittest.TestCase):
""" Tests for comparing phylogenetic trees with phylip tools """
def tearDown(self):
clean_up()
def test_fconsense(self):
""" Calculate a consensus tree with fconsense """
cline = FConsenseCommandline(exes["fconsense"],
intreefile = "Phylip/horses.tree",
outtreefile = "test_file",
auto = True, filter = True)
return_code = run_command(str(cline))
if return_code != 0:
raise ValueError("Return code %s from:\n%s" \
% (return_code, str(cline)))
taxa1 = parse_trees("test_file").next().get_taxa()
for tree in parse_trees("Phylip/horses.tree"):
taxa2 = tree.get_taxa()
self.assertEqual(sorted(taxa1),sorted(taxa2))
def test_ftreedist(self):
""" Calculate the distance between trees with ftreedist """
cline = FTreeDistCommandline(exes["ftreedist"],
intreefile = "Phylip/horses.tree",
outfile = "test_file",
auto = True, filter = True)
return_code = run_command(str(cline))
if return_code != 0:
raise ValueError("Return code %s from:\n%s" \
% (return_code, str(cline)))
self.assert_(os.path.isfile("test_file"))
if __name__ == "__main__":
runner = unittest.TextTestRunner(verbosity = 2)
unittest.main(testRunner=runner)
clean_up()
|
