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
461
462
463
464
465
466
467
|
//
// makelefse.cpp
// Mothur
//
// Created by SarahsWork on 6/3/13.
// Copyright (c) 2013 Schloss Lab. All rights reserved.
//
#include "makelefsecommand.h"
#include "designmap.h"
//**********************************************************************************************************************
vector<string> MakeLefseCommand::setParameters(){
try {
CommandParameter pshared("shared", "InputTypes", "", "", "SharedRel", "SharedRel", "none","lefse",false,false,true); parameters.push_back(pshared);
CommandParameter prelabund("relabund", "InputTypes", "", "", "SharedRel", "SharedRel", "none","lefse",false,false,true); parameters.push_back(prelabund);
CommandParameter pconstaxonomy("constaxonomy", "InputTypes", "", "", "none", "none", "none","",false,false,false); parameters.push_back(pconstaxonomy);
CommandParameter pdesign("design", "InputTypes", "", "", "none", "none", "none","",false,false, true); parameters.push_back(pdesign);
CommandParameter pgroups("groups", "String", "", "", "", "", "","",false,false); parameters.push_back(pgroups);
CommandParameter pscale("scale", "Multiple", "totalgroup-totalotu-averagegroup-averageotu", "totalgroup", "", "", "","",false,false); parameters.push_back(pscale);
CommandParameter plabel("label", "String", "", "", "", "", "","",false,false); parameters.push_back(plabel);
CommandParameter pseed("seed", "Number", "", "0", "", "", "","",false,false); parameters.push_back(pseed);
CommandParameter pinputdir("inputdir", "String", "", "", "", "", "","",false,false); parameters.push_back(pinputdir);
CommandParameter poutputdir("outputdir", "String", "", "", "", "", "","",false,false); parameters.push_back(poutputdir);
abort = false; calledHelp = false;
vector<string> tempOutNames;
outputTypes["lefse"] = tempOutNames;
vector<string> myArray;
for (int i = 0; i < parameters.size(); i++) { myArray.push_back(parameters[i].name); }
return myArray;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "setParameters");
exit(1);
}
}
//**********************************************************************************************************************
string MakeLefseCommand::getHelpString(){
try {
string helpString = "";
helpString += "The make.lefse command allows you to create a lefse formatted input file from mothur's output files.\n";
helpString += "The make.lefse command parameters are: shared, relabund, constaxonomy, design, scale, groups and label. The shared or relabund are required.\n";
helpString += "The shared parameter is used to input your shared file, http://www.wiki.mothur.org/wiki/Shared_file.\n";
helpString += "The relabund parameter is used to input your relabund file, http://www.wiki.mothur.org/wiki/Relabund_file.\n";
helpString += "The design parameter is used to input your design file, http://www.wiki.mothur.org/wiki/Design_File.\n";
helpString += "The constaxonomy parameter is used to input your taxonomy file. http://www.wiki.mothur.org/wiki/Constaxonomy_file. The contaxonomy file is the taxonomy file outputted by classify.otu(list=yourListfile, taxonomy=yourTaxonomyFile). Be SURE that the you are the constaxonomy file distance matches the shared file distance. ie, for *.0.03.cons.taxonomy set label=0.03. Mothur is smart enough to handle shared files that have been subsampled. \n";
helpString += "The scale parameter allows you to select what scale you would like to use to convert your shared file abundances to relative abundances. Choices are totalgroup, totalotu, averagegroup, averageotu, default is totalgroup.\n";
helpString += "The label parameter allows you to select what distance level you would like used, if none is given the first distance is used.\n";
helpString += "The make.lefse command should be in the following format: make.lefse(shared=yourSharedFile)\n";
helpString += "make.lefse(shared=final.an.shared)\n";
return helpString;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "getHelpString");
exit(1);
}
}
//**********************************************************************************************************************
string MakeLefseCommand::getOutputPattern(string type) {
try {
string pattern = "";
if (type == "lefse") { pattern = "[filename],[distance],lefse"; }
else { m->mothurOut("[ERROR]: No definition for type " + type + " output pattern.\n"); m->setControl_pressed(true); }
return pattern;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "getOutputPattern");
exit(1);
}
}
//**********************************************************************************************************************
MakeLefseCommand::MakeLefseCommand(string option) : Command() {
try {
if(option == "help") { help(); abort = true; calledHelp = true; }
else if(option == "citation") { citation(); abort = true; calledHelp = true;}
else if(option == "category") { abort = true; calledHelp = true; }
else {
OptionParser parser(option, setParameters());
map<string,string> parameters = parser.getParameters();
ValidParameters validParameter;
designfile = validParameter.validFile(parameters, "design");
if (designfile == "not open") { abort = true; }
else if (designfile == "not found") { designfile = ""; }
else { current->setDesignFile(designfile); }
sharedfile = validParameter.validFile(parameters, "shared");
if (sharedfile == "not open") { abort = true; }
else if (sharedfile == "not found") { sharedfile = ""; }
else { current->setSharedFile(sharedfile); }
relabundfile = validParameter.validFile(parameters, "relabund");
if (relabundfile == "not open") { abort = true; }
else if (relabundfile == "not found") { relabundfile = ""; }
else { current->setRelAbundFile(relabundfile); }
constaxonomyfile = validParameter.validFile(parameters, "constaxonomy");
if (constaxonomyfile == "not open") { constaxonomyfile = ""; abort = true; }
else if (constaxonomyfile == "not found") { constaxonomyfile = ""; }
label = validParameter.valid(parameters, "label");
if (label == "not found") { label = ""; m->mothurOut("You did not provide a label, I will use the first label in your inputfile.\n"); label=""; }
string groups = validParameter.valid(parameters, "groups");
if (groups == "not found") { groups = ""; }
else { util.splitAtDash(groups, Groups); if (Groups.size() != 0) { if (Groups[0]== "all") { Groups.clear(); } } }
if ((relabundfile == "") && (sharedfile == "")) {
//is there are current file available for either of these?
//give priority to shared, then relabund
sharedfile = current->getSharedFile();
if (sharedfile != "") { m->mothurOut("Using " + sharedfile + " as input file for the shared parameter.\n"); }
else {
relabundfile = current->getRelAbundFile();
if (relabundfile != "") { m->mothurOut("Using " + relabundfile + " as input file for the relabund parameter.\n"); }
else {
m->mothurOut("No valid current files. You must provide a shared or relabund.\n");
abort = true;
}
}
}
if ((relabundfile != "") && (sharedfile != "")) { m->mothurOut("[ERROR]: You may not use both a shared and relabund file.\n"); abort = true; }
scale = validParameter.valid(parameters, "scale"); if (scale == "not found") { scale = "totalgroup"; }
if ((scale != "totalgroup") && (scale != "totalotu") && (scale != "averagegroup") && (scale != "averageotu")) {
m->mothurOut(scale + " is not a valid scaling option for the get.relabund command. Choices are totalgroup, totalotu, averagegroup, averageotu.\n"); abort = true;
}
}
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "MakeLefseCommand");
exit(1);
}
}
//**********************************************************************************************************************
int MakeLefseCommand::execute(){
try {
if (abort) { if (calledHelp) { return 0; } return 2; }
map<int, consTax2> consTax;
if (constaxonomyfile != "") { util.readConsTax(constaxonomyfile, consTax); }
if (m->getControl_pressed()) { return 0; }
if (sharedfile != "") {
inputFile = sharedfile;
SharedRAbundFloatVectors* lookup = getSharedRelabund();
runRelabund(consTax, lookup);
}else {
inputFile = relabundfile;
SharedRAbundFloatVectors* lookup = getRelabund();
runRelabund(consTax, lookup);
}
if (m->getControl_pressed()) { for (int i = 0; i < outputNames.size(); i++) { util.mothurRemove(outputNames[i]); } return 0; }
//output files created by command
m->mothurOut("\nOutput File Names: \n");
for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i] +"\n"); } m->mothurOutEndLine();
return 0;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "execute");
exit(1);
}
}
//**********************************************************************************************************************
int MakeLefseCommand::runRelabund(map<int, consTax2>& consTax, SharedRAbundFloatVectors*& lookup){
try {
if (outputdir == "") { outputdir = util.hasPath(inputFile); }
map<string, string> variables;
variables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(inputFile));
variables["[distance]"] = lookup->getLabel();
string outputFile = getOutputFileName("lefse",variables);
outputNames.push_back(outputFile); outputTypes["lefse"].push_back(outputFile);
ofstream out;
util.openOutputFile(outputFile, out);
DesignMap* designMap = nullptr;
vector<string> namesOfGroups = lookup->getNamesGroups();
if (designfile != "") {
designMap = new DesignMap(designfile); if (m->getControl_pressed()) { out.close(); delete designMap; return 0; }
vector<string> categories = designMap->getNamesOfCategories();
if (categories.size() > 3) { m->mothurOut("\n[NOTE]: LEfSe input files allow for a class, subclass and subject. More than 3 categories can cause formatting errors.\n\n"); }
for (int j = 0; j < categories.size(); j++) {
out << categories[j];
for (int i = 0; i < namesOfGroups.size()-1; i++) {
if (m->getControl_pressed()) { out.close(); delete designMap; return 0; }
string value = designMap->get(namesOfGroups[i], categories[j]);
if (value == "not found") {
m->mothurOut("[ERROR]: " + namesOfGroups[i] + " is not in your design file, please correct.\n"); m->setControl_pressed(true);
}else { out << '\t' << value; }
}
string value = designMap->get(namesOfGroups[namesOfGroups.size()-1], categories[j]);
if (value == "not found") {
m->mothurOut("[ERROR]: " + namesOfGroups[namesOfGroups.size()-1] + " is not in your design file, please correct.\n"); m->setControl_pressed(true);
}else { out << '\t' << value; }
out << endl;
}
}
out << "group";
for (int i = 0; i < namesOfGroups.size(); i++) { out << '\t' << namesOfGroups[i]; }
out << endl;
for (int i = 0; i < lookup->getNumBins(); i++) { //process each otu
if (m->getControl_pressed()) { break; }
string nameOfOtu = lookup->getOTUName(i);
if (constaxonomyfile != "") { //try to find the otuName in consTax to replace with consensus taxonomy
int simpleLabel;
util.mothurConvert(util.getSimpleLabel(nameOfOtu), simpleLabel);
map<int, consTax2>::iterator it = consTax.find(simpleLabel);
if (it != consTax.end()) {
nameOfOtu = it->second.taxonomy;
//add sanity check abundances here??
string fixedName = "";
//remove confidences and change ; to |
util.removeConfidences(nameOfOtu);
for (int j = 0; j < nameOfOtu.length(); j++) {
if (nameOfOtu[j] == ';') { fixedName += '|'; }
else { fixedName += nameOfOtu[j]; }
}
nameOfOtu = fixedName + lookup->getOTUName(i) + "|";
}else {
m->mothurOut("[ERROR]: can't find " + nameOfOtu + " in constaxonomy file. Do the distances match, did you forget to use the label parameter?\n"); m->setControl_pressed(true);
}
}
//print name
out << nameOfOtu;
//print out relabunds for each otu
vector<float> abunds = lookup->getOTU(i);
for (int j = 0; j < abunds.size(); j++) { out << '\t' << abunds[j]; }
out << endl;
}
out.close();
return 0;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "execute");
exit(1);
}
}
//**********************************************************************************************************************
SharedRAbundFloatVectors* MakeLefseCommand::getSharedRelabund(){
try {
InputData input(sharedfile, "sharedfile", Groups);
SharedRAbundVectors* templookup = input.getSharedRAbundVectors();
Groups = templookup->getNamesGroups();
string lastLabel = templookup->getLabel();
if (label == "") { label = lastLabel; }
else {
//if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
set<string> labels; labels.insert(label);
set<string> processedLabels;
set<string> userLabels = labels;
//as long as you are not at the end of the file or done wih the lines you want
while((templookup != nullptr) && (userLabels.size() != 0)) {
if (m->getControl_pressed()) { delete templookup; return nullptr; }
if(labels.count(templookup->getLabel()) == 1){
processedLabels.insert(templookup->getLabel());
userLabels.erase(templookup->getLabel());
break;
}
if ((util.anyLabelsToProcess(templookup->getLabel(), userLabels, "") ) && (processedLabels.count(lastLabel) != 1)) {
string saveLabel = templookup->getLabel();
delete templookup;
templookup = input.getSharedRAbundVectors(lastLabel);
processedLabels.insert(templookup->getLabel());
userLabels.erase(templookup->getLabel());
//restore real lastlabel to save below
templookup->setLabels(saveLabel);
break;
}
lastLabel = templookup->getLabel();
//get next line to process
//prevent memory leak
delete templookup;
templookup = input.getSharedRAbundVectors();
}
if (m->getControl_pressed()) { delete templookup; return nullptr; }
//output error messages about any remaining user labels
set<string>::iterator it;
bool needToRun = false;
for (it = userLabels.begin(); it != userLabels.end(); it++) {
m->mothurOut("Your file does not include the label " + *it);
if (processedLabels.count(lastLabel) != 1) {
m->mothurOut(". I will use " + lastLabel + ".\n");
needToRun = true;
}else {
m->mothurOut(". Please refer to " + lastLabel + ".\n");
}
}
//run last label if you need to
if (needToRun ) {
delete templookup;
templookup = input.getSharedRAbundVectors(lastLabel);
}
}
vector<SharedRAbundVector*> data = templookup->getSharedRAbundVectors();
vector<string> otuNames = templookup->getOTUNames();
delete templookup;
SharedRAbundFloatVectors* lookup = new SharedRAbundFloatVectors();
//convert to relabund
for (int i = 0; i < data.size(); i++) {
SharedRAbundFloatVector* rel = new SharedRAbundFloatVector();
rel->setGroup(data[i]->getGroup());
rel->setLabel(data[i]->getLabel());
for (int j = 0; j < data[i]->getNumBins(); j++) {
if (m->getControl_pressed()) { for (int k = 0; k < data.size(); k++) { delete data[k]; } return lookup; }
int abund = data[i]->get(j);
float relabund = 0.0;
if (scale == "totalgroup") {
relabund = abund / (float) data[i]->getNumSeqs();
}else if (scale == "totalotu") {
//calc the total in this otu
int totalOtu = 0;
for (int l = 0; l < data.size(); l++) { totalOtu += data[l]->get(j); }
relabund = abund / (float) totalOtu;
}else if (scale == "averagegroup") {
relabund = abund / (float) (data[i]->getNumSeqs() / (float) data[i]->getNumBins());
}else if (scale == "averageotu") {
//calc the total in this otu
int totalOtu = 0;
for (int l = 0; l < data.size(); l++) { totalOtu += data[l]->get(j); }
float averageOtu = totalOtu / (float) data.size();
relabund = abund / (float) averageOtu;
}else{ m->mothurOut(scale + " is not a valid scaling option.\n"); m->setControl_pressed(true); }
rel->push_back(relabund);
}
lookup->push_back(rel);
}
for (int k = 0; k < data.size(); k++) { delete data[k]; } data.clear();
lookup->setOTUNames(otuNames);
lookup->eliminateZeroOTUS();
return lookup;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "getSharedRelabund");
exit(1);
}
}
//**********************************************************************************************************************
SharedRAbundFloatVectors* MakeLefseCommand::getRelabund(){
try {
InputData input(relabundfile, "relabund", Groups);
SharedRAbundFloatVectors* lookupFloat = input.getSharedRAbundFloatVectors();
string lastLabel = lookupFloat->getLabel();
Groups = lookupFloat->getNamesGroups();
if (label == "") { label = lastLabel; return lookupFloat; }
//if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
set<string> labels; labels.insert(label);
set<string> processedLabels;
set<string> userLabels = labels;
//as long as you are not at the end of the file or done wih the lines you want
while((lookupFloat != nullptr) && (userLabels.size() != 0)) {
if (m->getControl_pressed()) { return lookupFloat; }
if(labels.count(lookupFloat->getLabel()) == 1){
processedLabels.insert(lookupFloat->getLabel());
userLabels.erase(lookupFloat->getLabel());
break;
}
if ((util.anyLabelsToProcess(lookupFloat->getLabel(), userLabels, "") ) && (processedLabels.count(lastLabel) != 1)) {
string saveLabel = lookupFloat->getLabel();
delete lookupFloat;
lookupFloat = input.getSharedRAbundFloatVectors(lastLabel);
processedLabels.insert(lookupFloat->getLabel());
userLabels.erase(lookupFloat->getLabel());
//restore real lastlabel to save below
lookupFloat->setLabels(saveLabel);
break;
}
lastLabel = lookupFloat->getLabel();
//get next line to process
//prevent memory leak
delete lookupFloat;
lookupFloat = input.getSharedRAbundFloatVectors();
}
if (m->getControl_pressed()) { return lookupFloat; }
//output error messages about any remaining user labels
set<string>::iterator it;
bool needToRun = false;
for (it = userLabels.begin(); it != userLabels.end(); it++) {
m->mothurOut("Your file does not include the label " + *it);
if (processedLabels.count(lastLabel) != 1) {
m->mothurOut(". I will use " + lastLabel + ".\n");
needToRun = true;
}else {
m->mothurOut(". Please refer to " + lastLabel + ".\n");
}
}
//run last label if you need to
if (needToRun ) {
delete lookupFloat;
lookupFloat = input.getSharedRAbundFloatVectors(lastLabel);
}
return lookupFloat;
}
catch(exception& e) {
m->errorOut(e, "MakeLefseCommand", "getRelabund");
exit(1);
}
}
//**********************************************************************************************************************
|
