File: uniqueseqscommand.cpp

package info (click to toggle)
mothur 1.48.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 13,684 kB
  • sloc: cpp: 161,854; makefile: 122; sh: 31
file content (460 lines) | stat: -rwxr-xr-x 21,086 bytes parent folder | download | duplicates (4)
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
/*
 *  deconvolute.cpp
 *  Mothur
 *
 *  Created by Sarah Westcott on 1/21/09.
 *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
 *
 */

#include "uniqueseqscommand.h"
#include "sequence.hpp"

//**********************************************************************************************************************
vector<string> UniqueSeqsCommand::setParameters(){
	try {
		CommandParameter pfasta("fasta", "InputTypes", "", "", "none", "none", "none","fasta-name",false,true,true); parameters.push_back(pfasta);
		CommandParameter pname("name", "InputTypes", "", "", "namecount", "none", "none","name",false,false,true); parameters.push_back(pname);
        CommandParameter pcount("count", "InputTypes", "", "", "namecount", "none", "none","count",false,false,true); parameters.push_back(pcount);
        CommandParameter pformat("format", "Multiple", "count-name", "count", "", "", "","",false,false, true); parameters.push_back(pformat);
        CommandParameter poutput("output", "Multiple", "count-name", "count", "", "", "","",false,false, true); parameters.push_back(poutput);
        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["fasta"] = tempOutNames;
        outputTypes["name"] = tempOutNames;
        outputTypes["count"] = 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, "UniqueSeqsCommand", "setParameters");
		exit(1);
	}
}
//**********************************************************************************************************************
string UniqueSeqsCommand::getHelpString(){
	try {
		string helpString = "";
		helpString += "The unique.seqs command reads a fastafile and creates a name or count file.\n";
		helpString += "The unique.seqs command parameters are fasta, name, count and format.  fasta is required, unless there is a valid current fasta file.\n";
        helpString += "The name parameter is used to provide an existing name file associated with the fasta file. \n";
        helpString += "The count parameter is used to provide an existing count file associated with the fasta file. \n";
        helpString += "The format parameter is used to indicate what type of file you want outputted.  Choices are name and count, default=count unless name file used then default=name.\n";
		helpString += "The unique.seqs command should be in the following format: \n";
		helpString += "unique.seqs(fasta=yourFastaFile) \n";	
		return helpString;
	}
	catch(exception& e) {
		m->errorOut(e, "UniqueSeqsCommand", "getHelpString");
		exit(1);
	}
}
//**********************************************************************************************************************
string UniqueSeqsCommand::getOutputPattern(string type) {
    try {
        string pattern = "";
        
        if (type == "fasta") {  pattern = "[filename],unique,[extension]"; } 
        else if (type == "name") {  pattern = "[filename],names-[filename],[tag],names"; } 
        else if (type == "count") {  pattern = "[filename],count_table-[filename],[tag],count_table"; }
        else { m->mothurOut("[ERROR]: No definition for type " + type + " output pattern.\n"); m->setControl_pressed(true);  }
        
        return pattern;
    }
    catch(exception& e) {
        m->errorOut(e, "UniqueSeqsCommand", "getOutputPattern");
        exit(1);
    }
}
/**************************************************************************************/
UniqueSeqsCommand::UniqueSeqsCommand(string option) : Command()  {
	try {
		//allow user to run help
		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;
			fastafile = validParameter.validFile(parameters, "fasta");
			if (fastafile == "not open") { abort = true; }
			else if (fastafile == "not found") {
				fastafile = current->getFastaFile();
				if (fastafile != "") { m->mothurOut("Using " + fastafile + " as input file for the fasta parameter.\n");  }
				else { 	m->mothurOut("You have no current fastafile and the fasta parameter is required.\n");  abort = true; }
			}else { current->setFastaFile(fastafile); }
			
            if (outputdir == ""){ outputdir += util.hasPath(fastafile);  }
			
			namefile = validParameter.validFile(parameters, "name");
			if (namefile == "not open") { namefile = ""; abort = true; }
			else if (namefile == "not found"){	namefile = "";	}
			else { current->setNameFile(namefile); }
            
            countfile = validParameter.validFile(parameters, "count");
			if (countfile == "not open") { abort = true; countfile = ""; }	
			else if (countfile == "not found") { countfile = ""; }
			else { current->setCountFile(countfile); }
			
            if ((countfile != "") && (namefile != "")) { m->mothurOut("When executing a unique.seqs command you must enter ONLY ONE of the following: count or name.\n");  abort = true; }
			
            //allow format parameter to have two names - format or output
            format = validParameter.valid(parameters, "format");
            if(format == "not found"){
                format = validParameter.valid(parameters, "output");
                if(format == "not found"){
                    if (namefile != "") { format = "name";    }
                    else { format = "count";                  }
                }
            }
            
            if ((format != "name") && (format != "count")) {
                m->mothurOut(format + " is not a valid format option. Options are count or name.");
                if (countfile == "") { m->mothurOut("I will use count.\n"); format = "count"; }
                else {  m->mothurOut("I will use count.\n"); format = "count"; }
            }
			
		}

	}
	catch(exception& e) {
		m->errorOut(e, "UniqueSeqsCommand", "UniqueSeqsCommand");
		exit(1);
	}
}
/**************************************************************************************/
int UniqueSeqsCommand::execute() {
	try {
		
		if (abort) { if (calledHelp) { return 0; }  return 2;	}
        
        if (countfile != "")        {  processCount(countfile); }
        else if (namefile != "")    {  processName(namefile);   }
        else { //no existing duplicate data
            if (format == "count")      {  processCount("");        }
            else                        {  processName("");         }
        }
		if (m->getControl_pressed()) { return 0; }
		
		m->mothurOut("\nOutput File Names: \n");
        for (int i = 0; i < outputNames.size(); i++) {	m->mothurOut(outputNames[i] +"\n"); 	} m->mothurOutEndLine();

		//set fasta file as new current fastafile
		string currentName = "";
		itTypes = outputTypes.find("fasta");
		if (itTypes != outputTypes.end()) {
			if ((itTypes->second).size() != 0) { currentName = (itTypes->second)[0]; current->setFastaFile(currentName); }
		}
		
		itTypes = outputTypes.find("name");
		if (itTypes != outputTypes.end()) {
			if ((itTypes->second).size() != 0) { currentName = (itTypes->second)[0]; current->setNameFile(currentName); }
		}
        
        itTypes = outputTypes.find("count");
		if (itTypes != outputTypes.end()) {
			if ((itTypes->second).size() != 0) { currentName = (itTypes->second)[0]; current->setCountFile(currentName); }
		}
		
		return 0;
	}
	catch(exception& e) {
		m->errorOut(e, "UniqueSeqsCommand", "execute");
		exit(1);
	}
}
/**************************************************************************************/
string UniqueSeqsCommand::processCount(string countfile) { //countfile can be blank, indicating no countfile provided
    try {
        if (format == "name") {
            if (countfile == "") {  return (processName("")); }
            else {
                CountTable ct; ct.readTable(countfile, true, false);
                map<string, int> nameMap = ct.getNameMap();
                
                string newNamesFile = createNewNameFile(countfile, nameMap);
                
                return (processName(newNamesFile));
            }
        }
        
        map<string, string> variables;
        variables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(fastafile));
        string outCountFile = getOutputFileName("count", variables);
        variables["[extension]"] = util.getExtension(fastafile);
        string outFastaFile = getOutputFileName("fasta", variables);
        
        CountTable ct; CountTable newCt;
        if (countfile != "")  {
            ct.readTable(countfile, true, false);
            if (countfile == outCountFile){
                //prepare filenames and open files
                map<string, string> mvariables;
                mvariables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(fastafile));
                mvariables["[tag]"] = "unique";
                outCountFile = getOutputFileName("count", mvariables);
            }
            newCt.copy(&ct);
        }
        
        if (m->getControl_pressed()) { return 0; }
        
        ifstream in;  util.openInputFile(fastafile, in);
        ofstream outFasta; util.openOutputFile(outFastaFile, outFasta);
        outputNames.push_back(outFastaFile); outputTypes["fasta"].push_back(outFastaFile);
        
        map<string, string> sequenceStrings; //sequenceString -> list of names.  "atgc...." -> seq1,seq2,seq3.
        map<string, string>::iterator itStrings;
        set<string> nameInFastaFile; //for sanity checking
        set<string>::iterator itname;
        vector<string> nameFileOrder;
        
        int count = 0;
        
        while (!in.eof()) {
            
            if (m->getControl_pressed()) { break; }
            
            Sequence seq(in); gobble(in);
            
            if (seq.getName() != "") { //not end of file
                
                //sanity checks
                itname = nameInFastaFile.find(seq.getName());
                if (itname == nameInFastaFile.end()) { nameInFastaFile.insert(seq.getName());  }
                else { m->mothurOut("[ERROR]: You already have a sequence named " + seq.getName() + " in your fasta file, sequence names must be unique, please correct.\n");  }
                
                itStrings = sequenceStrings.find(seq.getAligned());
                string seqName = seq.getName();
                int numCurrentReps = 0;
                
                if (itStrings == sequenceStrings.end()) { //this is a new unique sequence
                    
                    seq.printSequence(outFasta); //output to unique fasta file
                    sequenceStrings[seq.getAligned()] = seqName;    nameFileOrder.push_back(seq.getAligned());
                    
                    if (countfile != "") { numCurrentReps = ct.getNumSeqs(seqName); } //checks to make sure seq is in table
                    else { newCt.push_back(seqName); }
                    
                }else { //this is a dup
                    
                    if (countfile != "") {
                        
                        numCurrentReps = newCt.getNumSeqs(seq.getName()); //checks to make sure seq is in table
                        
                        if (numCurrentReps != 0) { //its in the table
                            newCt.mergeCounts(itStrings->second, seq.getName()); //merges counts and saves in uniques name
                        }
                    }else {
                        numCurrentReps = newCt.getNumSeqs(itStrings->second);
                        newCt.setNumSeqs(itStrings->second, numCurrentReps+1);
                    }
                }
                count++;
            }
            
            
            if(count % 1000 == 0)    { m->mothurOutJustToScreen(toString(count) + "\t" + toString(sequenceStrings.size()) + "\n");    }
        }
        
        if(count % 1000 != 0)    { m->mothurOut(toString(count) + "\t" + toString(sequenceStrings.size())); m->mothurOutEndLine();    }
        
        in.close(); outFasta.close();
        if (m->getControl_pressed()) {  util.mothurRemove(outFastaFile); }
        
        //print new names file
        ofstream outCount; util.openOutputFile(outCountFile, outCount); outputTypes["count"].push_back(outCountFile); outputNames.push_back(outCountFile);
        
        newCt.printCompressedHeaders(outCount);
        
        for (int i = 0; i < nameFileOrder.size(); i++) {
            if (m->getControl_pressed()) { break; }
            
            itStrings = sequenceStrings.find(nameFileOrder[i]);
            
            if (itStrings != sequenceStrings.end()) {
                newCt.printCompressedSeq(outCount, itStrings->second);
            }else{ m->mothurOut("[ERROR]: mismatch in namefile print.\n");  m->setControl_pressed(true); }
        }
        outCount.close();
        
        if (m->getControl_pressed()) {  util.mothurRemove(outFastaFile);  util.mothurRemove(outCountFile);  outputTypes.clear(); outputNames.clear(); }
        
        return outFastaFile;
        
    }
    catch(exception& e) {
        m->errorOut(e, "UniqueSeqsCommand", "processCount");
        exit(1);
    }
}
/**************************************************************************************/
string UniqueSeqsCommand::processName(string namefile) { //namefile can be blank, indicating no namefile provided
    try {
        
        if (format == "count") { //if user want to convert the count file to a names file, do that first
            if (namefile == "") {  return (processCount("")); }
            else {
                //convert name to count
                map<string, string> variables;
                variables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(namefile));
                string newCountFile = getOutputFileName("count", variables);
                
                CountTable ct; ct.createTable(namefile, "", nullVector);
                ct.printCompressedTable(newCountFile);
                
                return (processCount(newCountFile));
            }
        }
        
        //assumes output is name and namefile is given
        //prepare filenames
        map<string, string> variables;
        variables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(fastafile));
        string outNameFile = getOutputFileName("name", variables);
        variables["[extension]"] = util.getExtension(fastafile);
        string outFastaFile = getOutputFileName("fasta", variables);
        
        //check for name overwrite
        if (namefile == outNameFile){
            map<string, string> mvariables;
            mvariables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(fastafile));
            mvariables["[tag]"] = "unique";
            outNameFile = getOutputFileName("name", mvariables);
        }
        
        map<string, string> nameMap; map<string, string>::iterator itNames;
        if (namefile != "") {  util.readNames(namefile, nameMap); } //add existing duplicates
        
        //bail if error reading namefile
        if (m->getControl_pressed()) { return ""; }
        
        //open files
        ifstream in;  util.openInputFile(fastafile, in);
        ofstream outFasta; util.openOutputFile(outFastaFile, outFasta);
        outputNames.push_back(outFastaFile); outputTypes["fasta"].push_back(outFastaFile);
        
        map<string, string> sequenceStrings; //sequenceString -> list of names.  "atgc...." -> seq1,seq2,seq3.
        map<string, string>::iterator itStrings;
        set<string> nameInFastaFile; //for sanity checking
        set<string>::iterator itname;
        vector<string> nameFileOrder;
        
        int count = 0;
        while (!in.eof()) {
            
            if (m->getControl_pressed()) { break; }
            
            Sequence seq(in); gobble(in);
            
            if (seq.getName() != "") { //not end of file
                
                //sanity checks
                itname = nameInFastaFile.find(seq.getName());
                if (itname == nameInFastaFile.end()) { nameInFastaFile.insert(seq.getName());  }
                else { m->mothurOut("[ERROR]: You already have a sequence named " + seq.getName() + " in your fasta file, sequence names must be unique, please correct.\n");  }
                
                string key = seq.getName();
                
                if (namefile != "") {
                    itNames = nameMap.find(seq.getName());
                    
                    if (itNames == nameMap.end()) { //namefile and fastafile do not match
                        m->mothurOut("[ERROR]: " + seq.getName() + " is in your fasta file, and not in your namefile, please correct.\n");
                    }else { key = itNames->second;  }
                }

                itStrings = sequenceStrings.find(seq.getAligned());
                
                if (itStrings == sequenceStrings.end()) { //this is a new unique sequence
                    
                    seq.printSequence(outFasta); //output to unique fasta file
                    
                    //add new unique sequence to seqStrings
                    sequenceStrings[seq.getAligned()] = key;    nameFileOrder.push_back(seq.getAligned());
                    
                }else { //this is a dup
                     sequenceStrings[seq.getAligned()] += "," + key;
                }
                count++;
            }
            
            
            if(count % 1000 == 0)    { m->mothurOutJustToScreen(toString(count) + "\t" + toString(sequenceStrings.size()) + "\n");    }
        }
        
        if(count % 1000 != 0)    { m->mothurOut(toString(count) + "\t" + toString(sequenceStrings.size())); m->mothurOutEndLine();    }
        
        in.close(); outFasta.close();
        if (m->getControl_pressed()) {  return outFastaFile;  }
        
        ofstream outNames; util.openOutputFile(outNameFile, outNames);
        outputNames.push_back(outNameFile); outputTypes["name"].push_back(outNameFile);
         
        for (int i = 0; i < nameFileOrder.size(); i++) {
            if (m->getControl_pressed()) { break; }
            
            itStrings = sequenceStrings.find(nameFileOrder[i]);
            
            if (itStrings != sequenceStrings.end()) {
                //get rep name
                int pos = (itStrings->second).find_first_of(',');
                
                if (pos == string::npos) { // only reps itself
                    outNames << itStrings->second << '\t' << itStrings->second << endl;
                }else {
                    outNames << (itStrings->second).substr(0, pos) << '\t' << itStrings->second << endl;
                }
                
            }else{ m->mothurOut("[ERROR]: mismatch in namefile print.\n");  m->setControl_pressed(true); }
        }
        outNames.close();
        
        if (m->getControl_pressed()) {  util.mothurRemove(outFastaFile);  util.mothurRemove(outNameFile);  outputTypes.clear(); outputNames.clear(); }
        
        return outFastaFile;
    }
    catch(exception& e) {
        m->errorOut(e, "UniqueSeqsCommand", "processName");
        exit(1);
    }
}
/**************************************************************************************/
string UniqueSeqsCommand::createNewNameFile(string countfile, map<string, int> nameMap) { //namefile can be blank, indicating no namefile provided
    try {
        map<string, string> variables;
        variables["[filename]"] = outputdir + util.getRootName(util.getSimpleName(countfile));
        string outNameFile = getOutputFileName("name", variables);
        
        ofstream out; util.openOutputFile(outNameFile, out);
         
        for (map<string, int>::iterator it = nameMap.begin(); it != nameMap.end(); it++) {
            string seqName = it->first;
            string expandedName = seqName;
            int numSeqs = it->second;
            
            for (int i = 1; i < numSeqs; i++) {  expandedName += "," + seqName + "_" + toString(i);  }
            
            out << seqName << '\t' << expandedName << endl;
        }

        out.close();
        
        return outNameFile;
    }
    catch(exception& e) {
        m->errorOut(e, "UniqueSeqsCommand", "createNewNameFile");
        exit(1);
    }
}
/**************************************************************************************/