annotate tools/ncbi_blast_plus/blastxml_to_top_descr.py @ 4:34a0adda2770 draft

Uploaded v0.0.3 which includes the test files required for the unit tests.
author peterjc
date Wed, 20 Feb 2013 13:18:07 -0500
parents 075fe5424c32
children 8a0771c5e236
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
1 #!/usr/bin/env python
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
2 """Convert a BLAST XML file to a top hits description table.
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
3
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
4 Takes three command line options, input BLAST XML filename, output tabular
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
5 BLAST filename, number of hits to collect the descriptions of.
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
6 """
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
7 import sys
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
8 import re
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
9
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
10 if sys.version_info[:2] >= ( 2, 5 ):
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
11 import xml.etree.cElementTree as ElementTree
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
12 else:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
13 from galaxy import eggs
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
14 import pkg_resources; pkg_resources.require( "elementtree" )
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
15 from elementtree import ElementTree
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
16
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
17 def stop_err( msg ):
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
18 sys.stderr.write("%s\n" % msg)
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
19 sys.exit(1)
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
20
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
21 #Parse Command Line
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
22 try:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
23 in_file, out_file, topN = sys.argv[1:]
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
24 except:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
25 stop_err("Expect 3 arguments: input BLAST XML file, output tabular file, number of hits")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
26
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
27
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
28 try:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
29 topN = int(topN)
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
30 except ValueError:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
31 stop_err("Number of hits argument should be an integer (at least 1)")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
32 if topN < 1:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
33 stop_err("Number of hits argument should be an integer (at least 1)")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
34
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
35 # get an iterable
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
36 try:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
37 context = ElementTree.iterparse(in_file, events=("start", "end"))
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
38 except:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
39 stop_err("Invalid data format.")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
40 # turn it into an iterator
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
41 context = iter(context)
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
42 # get the root element
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
43 try:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
44 event, root = context.next()
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
45 except:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
46 stop_err( "Invalid data format." )
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
47
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
48
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
49 re_default_query_id = re.compile("^Query_\d+$")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
50 assert re_default_query_id.match("Query_101")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
51 assert not re_default_query_id.match("Query_101a")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
52 assert not re_default_query_id.match("MyQuery_101")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
53 re_default_subject_id = re.compile("^Subject_\d+$")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
54 assert re_default_subject_id.match("Subject_1")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
55 assert not re_default_subject_id.match("Subject_")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
56 assert not re_default_subject_id.match("Subject_12a")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
57 assert not re_default_subject_id.match("TheSubject_1")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
58
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
59
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
60 count = 0
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
61 outfile = open(out_file, 'w')
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
62 outfile.write("#Query\t%s\n" % "\t".join("BLAST hit %i" % (i+1) for i in range(topN)))
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
63 for event, elem in context:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
64 # for every <Iteration> tag
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
65 if event == "end" and elem.tag == "Iteration":
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
66 #Expecting either this, from BLAST 2.2.25+ using FASTA vs FASTA
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
67 # <Iteration_query-ID>sp|Q9BS26|ERP44_HUMAN</Iteration_query-ID>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
68 # <Iteration_query-def>Endoplasmic reticulum resident protein 44 OS=Homo sapiens GN=ERP44 PE=1 SV=1</Iteration_query-def>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
69 # <Iteration_query-len>406</Iteration_query-len>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
70 # <Iteration_hits></Iteration_hits>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
71 #
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
72 #Or, from BLAST 2.2.24+ run online
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
73 # <Iteration_query-ID>Query_1</Iteration_query-ID>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
74 # <Iteration_query-def>Sample</Iteration_query-def>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
75 # <Iteration_query-len>516</Iteration_query-len>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
76 # <Iteration_hits>...
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
77 qseqid = elem.findtext("Iteration_query-ID")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
78 if qseqid is None:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
79 stop_err("Missing <Iteration_query-ID> (could be really old BLAST XML data?)")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
80 if re_default_query_id.match(qseqid):
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
81 #Place holder ID, take the first word of the query definition
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
82 qseqid = elem.findtext("Iteration_query-def").split(None,1)[0]
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
83 # for every <Hit> within <Iteration>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
84 hit_descrs = []
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
85 for hit in elem.findall("Iteration_hits/Hit"):
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
86 #Expecting either this,
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
87 # <Hit_id>gi|3024260|sp|P56514.1|OPSD_BUFBU</Hit_id>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
88 # <Hit_def>RecName: Full=Rhodopsin</Hit_def>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
89 # <Hit_accession>P56514</Hit_accession>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
90 #or,
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
91 # <Hit_id>Subject_1</Hit_id>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
92 # <Hit_def>gi|57163783|ref|NP_001009242.1| rhodopsin [Felis catus]</Hit_def>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
93 # <Hit_accession>Subject_1</Hit_accession>
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
94 #
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
95 #apparently depending on the parse_deflines switch
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
96 sseqid = hit.findtext("Hit_id").split(None,1)[0]
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
97 hit_def = sseqid + " " + hit.findtext("Hit_def")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
98 if re_default_subject_id.match(sseqid) \
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
99 and sseqid == hit.findtext("Hit_accession"):
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
100 #Place holder ID, take the first word of the subject definition
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
101 hit_def = hit.findtext("Hit_def")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
102 sseqid = hit_def.split(None,1)[0]
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
103 assert hit_def not in hit_descrs
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
104 hit_descrs.append(hit_def)
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
105 #print "%r has %i hits" % (qseqid, len(hit_descrs))
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
106 hit_descrs = hit_descrs[:topN]
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
107 while len(hit_descrs) < topN:
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
108 hit_descrs.append("")
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
109 outfile.write("%s\t%s\n" % (qseqid, "\t".join(hit_descrs)))
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
110 count += 1
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
111 # prevents ElementTree from growing large datastructure
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
112 root.clear()
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
113 elem.clear()
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
114 outfile.close()
075fe5424c32 Uploaded v0.0.1
peterjc
parents:
diff changeset
115 print "%i BLAST results" % count