-
Notifications
You must be signed in to change notification settings - Fork 89
/
kreport2mpa.py
executable file
·196 lines (187 loc) · 7.77 KB
/
kreport2mpa.py
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
#!/usr/bin/env python
####################################################################
#kreport2mpa.py converts a Kraken-style report into mpa [MetaPhlAn) format
#Copyright (C) 2017-2020 Jennifer Lu, [email protected]
#This file is part of KrakenTools.
#KrakenTools is free software; you can redistribute it and/or modify
#it under the terms of the GNU General Public License as published by
#the Free Software Foundation; either version 3 of the license, or
#(at your option) any later version.
#This program is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#GNU General Public License for more details.
#You should have received a copy of the GNU General Public License
#along with this program; if not, see <http://www.gnu.org/licenses/>.
####################################################################
#Jennifer Lu, [email protected]
#11/06/2017
#Updated: 07/12/2020
#
#This program reads in a Kraken report file and generates
#an mpa-format (MetaPhlAn) style report. Each line represents
#a possible taxon classification. The first column is lists the
#domain, kingdom, phyla, etc, leading up to each taxon.
#The levels are separated by the | delimiter, with the type of
#level specified before each name with a single letter and underscore
#(d_ for domain, k_ for kingdom, etc).
#The second column is the number of reads classified within
#that taxon's subtree.
#
#Input file:
# - Kraken report file generates from the kraken raw output file
#Input Parameters to Specify [OPTIONAL]:
# - header_line = prints a header line in mpa-report
# [Default: no header]
# - intermediate-ranks = includes non-traditional taxon levels
# (traditional levels: domain, kingdom, phylum, class, order,
# family, genus, species)
# [Default: no intermediate ranks]
#Output file format (tab-delimited)
# - Taxonomy tree levels |-delimited, with level type [d,k,p,c,o,f,g,s,x]
# - Number of reads within subtree of the specified level
#
#Methods
# - main
# - process_kraken_report
#
import os, sys, argparse
#process_kraken_report
#usage: parses a single line in the kraken report and extracts relevant information
#input: kraken report file with the following tab delimited lines
# - percent of total reads
# - number of reads (including at lower levels)
# - number of reads (only at this level)
# - taxonomy classification of level
# (U, D, P, C, O, F, G, S, -)
# - taxonomy ID (0 = unclassified, 1 = root, 2 = Bacteria,...etc)
# - spaces + name
#returns:
# - classification/genome name
# - level name (U, -, D, P, C, O, F, G, S)
# - reads classified at this level and below in the tree
def process_kraken_report(curr_str, remove_spaces):
split_str = curr_str.strip().split('\t')
if len(split_str) < 4:
return []
try:
int(split_str[1])
except ValueError:
return []
percents = float(split_str[0])
all_reads = int(split_str[1])
#Extract relevant information
try:
taxid = int(split_str[-3])
level_type = split_str[-2]
map_kuniq = {'species':'S', 'genus':'G','family':'F',
'order':'O','class':'C','phylum':'P','superkingdom':'D',
'kingdom':'K'}
if level_type not in map_kuniq:
level_type = '-'
else:
level_type = map_kuniq[level_type]
except ValueError:
taxid = int(split_str[-2])
level_type = split_str[-3]
#Get name and spaces
spaces = 0
name = split_str[-1]
for char in name:
if char == ' ':
name = name[1:]
spaces += 1
else:
break
if remove_spaces == True:
name = name.replace(' ','_')
#Determine level based on number of spaces
level_num = spaces/2
return [name, level_num, level_type, all_reads, percents]
#Main method
def main():
#Parse arguments
parser = argparse.ArgumentParser()
parser.add_argument('-r', '--report-file', '--report', required=True,
dest='r_file', help='Input kraken report file for converting')
parser.add_argument('-o', '--output', required=True,
dest='o_file', help='Output mpa-report file name')
parser.add_argument('--display-header', action='store_true',
dest='add_header', default=False, required=False,
help='Include header [Kraken report filename] in mpa-report file [default: no header]')
parser.add_argument('--read_count', action='store_true',
dest='use_reads', default=True, required=False,
help='Use read count for output [default]')
parser.add_argument('--percentages', action='store_false',
dest='use_reads', default=True, required=False,
help='Use percentages for output [instead of reads]')
parser.add_argument('--intermediate-ranks', action='store_true',
dest='x_include', default=False, required=False,
help='Include non-traditional taxonomic ranks in output')
parser.add_argument('--no-intermediate-ranks', action='store_false',
dest='x_include', default=False, required=False,
help='Do not include non-traditional taxonomic ranks in output [default]')
group = parser.add_mutually_exclusive_group()
group.add_argument('--remove-spaces', action='store_true',
dest='remove_spaces', default=True, required=False,
help='Replace space with underscore in taxon name [default]')
group.add_argument('--keep-spaces', action='store_false',
dest='remove_spaces', default=False, required=False,
help='Do not replace space with underscore in taxon name')
args=parser.parse_args()
#Process report file and output
curr_path = []
prev_lvl_num = -1
r_file = open(args.r_file, 'r')
o_file = open(args.o_file, 'w')
#Print header
if args.add_header:
o_file.write("#Classification\t" + os.path.basename(args.r_file) + "\n")
#Read through report file
main_lvls = ['R','K','D','P','C','O','F','G','S']
for line in r_file:
report_vals = process_kraken_report(line, args.remove_spaces)
#If header line, skip
if len(report_vals) < 5:
continue
#Get relevant information from the line
[name, level_num, level_type, all_reads, percents] = report_vals
if level_type == 'U':
continue
#Create level name
if level_type not in main_lvls:
level_type = "x"
elif level_type == "K":
level_type = "k"
elif level_type == "D":
level_type = "d"
level_str = level_type.lower() + "__" + name
#Determine full string to add
if prev_lvl_num == -1:
#First level
prev_lvl_num = level_num
curr_path.append(level_str)
else:
#Move back if needed
while level_num != (prev_lvl_num + 1):
prev_lvl_num -= 1
curr_path.pop()
#Print if at non-traditional level and that is requested
if (level_type == "x" and args.x_include) or level_type != "x":
#Print all ancestors of current level followed by |
for string in curr_path:
if (string[0] == "x" and args.x_include) or string[0] != "x":
if string[0] != "r":
o_file.write(string + "|")
#Print final level and then number of reads
if args.use_reads:
o_file.write(level_str + "\t" + str(all_reads) + "\n")
else:
o_file.write(level_str + "\t" + str(percents) + "\n")
#Update
curr_path.append(level_str)
prev_lvl_num = level_num
o_file.close()
r_file.close()
if __name__ == "__main__":
main()