2 * classifyseqscommand.cpp
5 * Created by westcott on 11/2/09.
6 * Copyright 2009 Schloss Lab. All rights reserved.
10 #include "classifyseqscommand.h"
14 //**********************************************************************************************************************
15 vector<string> ClassifySeqsCommand::setParameters(){
17 CommandParameter ptaxonomy("taxonomy", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(ptaxonomy);
18 CommandParameter ptemplate("reference", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(ptemplate);
19 CommandParameter pfasta("fasta", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(pfasta);
20 CommandParameter pname("name", "InputTypes", "", "", "none", "none", "none",false,false); parameters.push_back(pname);
21 CommandParameter pgroup("group", "InputTypes", "", "", "none", "none", "none",false,false); parameters.push_back(pgroup);
22 CommandParameter psearch("search", "Multiple", "kmer-blast-suffix-distance", "kmer", "", "", "",false,false); parameters.push_back(psearch);
23 CommandParameter pksize("ksize", "Number", "", "8", "", "", "",false,false); parameters.push_back(pksize);
24 CommandParameter pmethod("method", "Multiple", "bayesian-knn", "bayesian", "", "", "",false,false); parameters.push_back(pmethod);
25 CommandParameter pprocessors("processors", "Number", "", "1", "", "", "",false,false); parameters.push_back(pprocessors);
26 CommandParameter pmatch("match", "Number", "", "1.0", "", "", "",false,false); parameters.push_back(pmatch);
27 CommandParameter pmismatch("mismatch", "Number", "", "-1.0", "", "", "",false,false); parameters.push_back(pmismatch);
28 CommandParameter pgapopen("gapopen", "Number", "", "-2.0", "", "", "",false,false); parameters.push_back(pgapopen);
29 CommandParameter pgapextend("gapextend", "Number", "", "-1.0", "", "", "",false,false); parameters.push_back(pgapextend);
30 //CommandParameter pflip("flip", "Boolean", "", "F", "", "", "",false,false); parameters.push_back(pflip);
31 CommandParameter pcutoff("cutoff", "Number", "", "0", "", "", "",false,true); parameters.push_back(pcutoff);
32 CommandParameter pprobs("probs", "Boolean", "", "T", "", "", "",false,false); parameters.push_back(pprobs);
33 CommandParameter piters("iters", "Number", "", "100", "", "", "",false,true); parameters.push_back(piters);
34 CommandParameter psave("save", "Boolean", "", "F", "", "", "",false,false); parameters.push_back(psave);
35 CommandParameter pnumwanted("numwanted", "Number", "", "10", "", "", "",false,true); parameters.push_back(pnumwanted);
36 CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir);
37 CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir);
39 vector<string> myArray;
40 for (int i = 0; i < parameters.size(); i++) { myArray.push_back(parameters[i].name); }
44 m->errorOut(e, "ClassifySeqsCommand", "setParameters");
48 //**********************************************************************************************************************
49 string ClassifySeqsCommand::getHelpString(){
51 string helpString = "";
52 helpString += "The classify.seqs command reads a fasta file containing sequences and creates a .taxonomy file and a .tax.summary file.\n";
53 helpString += "The classify.seqs command parameters are reference, fasta, name, search, ksize, method, taxonomy, processors, match, mismatch, gapopen, gapextend, numwanted and probs.\n";
54 helpString += "The reference, fasta and taxonomy parameters are required. You may enter multiple fasta files by separating their names with dashes. ie. fasta=abrecovery.fasta-amzon.fasta \n";
55 helpString += "The search parameter allows you to specify the method to find most similar template. Your options are: suffix, kmer, blast and distance. The default is kmer.\n";
56 helpString += "The name parameter allows you add a names file with your fasta file, if you enter multiple fasta files, you must enter matching names files for them.\n";
57 helpString += "The group parameter allows you add a group file so you can have the summary totals broken up by group.\n";
58 helpString += "The method parameter allows you to specify classification method to use. Your options are: bayesian and knn. The default is bayesian.\n";
59 helpString += "The ksize parameter allows you to specify the kmer size for finding most similar template to candidate. The default is 8.\n";
60 helpString += "The processors parameter allows you to specify the number of processors to use. The default is 1.\n";
62 helpString += "When using MPI, the processors parameter is set to the number of MPI processes running. \n";
64 helpString += "If the save parameter is set to true the reference sequences will be saved in memory, to clear them later you can use the clear.memory command. Default=f.";
65 helpString += "The match parameter allows you to specify the bonus for having the same base. The default is 1.0.\n";
66 helpString += "The mistmatch parameter allows you to specify the penalty for having different bases. The default is -1.0.\n";
67 helpString += "The gapopen parameter allows you to specify the penalty for opening a gap in an alignment. The default is -2.0.\n";
68 helpString += "The gapextend parameter allows you to specify the penalty for extending a gap in an alignment. The default is -1.0.\n";
69 helpString += "The numwanted parameter allows you to specify the number of sequence matches you want with the knn method. The default is 10.\n";
70 helpString += "The cutoff parameter allows you to specify a bootstrap confidence threshold for your taxonomy. The default is 0.\n";
71 helpString += "The probs parameter shuts off the bootstrapping results for the bayesian method. The default is true, meaning you want the bootstrapping to be shown.\n";
72 helpString += "The iters parameter allows you to specify how many iterations to do when calculating the bootstrap confidence score for your taxonomy with the bayesian method. The default is 100.\n";
73 //helpString += "The flip parameter allows you shut off mothur's The default is T.\n";
74 helpString += "The classify.seqs command should be in the following format: \n";
75 helpString += "classify.seqs(reference=yourTemplateFile, fasta=yourFastaFile, method=yourClassificationMethod, search=yourSearchmethod, ksize=yourKmerSize, taxonomy=yourTaxonomyFile, processors=yourProcessors) \n";
76 helpString += "Example classify.seqs(fasta=amazon.fasta, reference=core.filtered, method=knn, search=gotoh, ksize=8, processors=2)\n";
77 helpString += "The .taxonomy file consists of 2 columns: 1 = your sequence name, 2 = the taxonomy for your sequence. \n";
78 helpString += "The .tax.summary is a summary of the different taxonomies represented in your fasta file. \n";
79 helpString += "Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFastaFile).\n";
83 m->errorOut(e, "ClassifySeqsCommand", "getHelpString");
87 //**********************************************************************************************************************
88 ClassifySeqsCommand::ClassifySeqsCommand(){
90 abort = true; calledHelp = true;
92 vector<string> tempOutNames;
93 outputTypes["taxonomy"] = tempOutNames;
94 outputTypes["accnos"] = tempOutNames;
95 outputTypes["taxsummary"] = tempOutNames;
96 outputTypes["matchdist"] = tempOutNames;
99 m->errorOut(e, "ClassifySeqsCommand", "ClassifySeqsCommand");
103 //**********************************************************************************************************************
104 ClassifySeqsCommand::ClassifySeqsCommand(string option) {
106 abort = false; calledHelp = false;
107 rdb = ReferenceDB::getInstance();
109 //allow user to run help
110 if(option == "help") { help(); abort = true; calledHelp = true; }
111 else if(option == "citation") { citation(); abort = true; calledHelp = true;}
114 vector<string> myArray = setParameters();
116 OptionParser parser(option);
117 map<string, string> parameters = parser.getParameters();
119 ValidParameters validParameter("classify.seqs");
120 map<string, string>::iterator it;
122 //check to make sure all parameters are valid for command
123 for (it = parameters.begin(); it != parameters.end(); it++) {
124 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
127 //initialize outputTypes
128 vector<string> tempOutNames;
129 outputTypes["taxonomy"] = tempOutNames;
130 outputTypes["taxsummary"] = tempOutNames;
131 outputTypes["matchdist"] = tempOutNames;
132 outputTypes["accnos"] = tempOutNames;
134 //if the user changes the output directory command factory will send this info to us in the output parameter
135 outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){ outputDir = ""; }
137 //if the user changes the input directory command factory will send this info to us in the output parameter
138 string inputDir = validParameter.validFile(parameters, "inputdir", false);
139 if (inputDir == "not found"){ inputDir = ""; }
142 it = parameters.find("reference");
143 //user has given a template file
144 if(it != parameters.end()){
145 path = m->hasPath(it->second);
146 //if the user has not given a path then, add inputdir. else leave path alone.
147 if (path == "") { parameters["reference"] = inputDir + it->second; }
150 it = parameters.find("taxonomy");
151 //user has given a template file
152 if(it != parameters.end()){
153 path = m->hasPath(it->second);
154 //if the user has not given a path then, add inputdir. else leave path alone.
155 if (path == "") { parameters["taxonomy"] = inputDir + it->second; }
158 it = parameters.find("group");
159 //user has given a template file
160 if(it != parameters.end()){
161 path = m->hasPath(it->second);
162 //if the user has not given a path then, add inputdir. else leave path alone.
163 if (path == "") { parameters["group"] = inputDir + it->second; }
167 fastaFileName = validParameter.validFile(parameters, "fasta", false);
168 if (fastaFileName == "not found") {
169 //if there is a current fasta file, use it
170 string filename = m->getFastaFile();
171 if (filename != "") { fastaFileNames.push_back(filename); m->mothurOut("Using " + filename + " as input file for the fasta parameter."); m->mothurOutEndLine(); }
172 else { m->mothurOut("You have no current fastafile and the fasta parameter is required."); m->mothurOutEndLine(); abort = true; }
175 m->splitAtDash(fastaFileName, fastaFileNames);
177 //go through files and make sure they are good, if not, then disregard them
178 for (int i = 0; i < fastaFileNames.size(); i++) {
181 if (fastaFileNames[i] == "current") {
182 fastaFileNames[i] = m->getFastaFile();
183 if (fastaFileNames[i] != "") { m->mothurOut("Using " + fastaFileNames[i] + " as input file for the fasta parameter where you had given current."); m->mothurOutEndLine(); }
185 m->mothurOut("You have no current fastafile, ignoring current."); m->mothurOutEndLine(); ignore=true;
186 //erase from file list
187 fastaFileNames.erase(fastaFileNames.begin()+i);
194 if (inputDir != "") {
195 string path = m->hasPath(fastaFileNames[i]);
196 //if the user has not given a path then, add inputdir. else leave path alone.
197 if (path == "") { fastaFileNames[i] = inputDir + fastaFileNames[i]; }
203 ableToOpen = m->openInputFile(fastaFileNames[i], in, "noerror");
205 //if you can't open it, try default location
206 if (ableToOpen == 1) {
207 if (m->getDefaultPath() != "") { //default path is set
208 string tryPath = m->getDefaultPath() + m->getSimpleName(fastaFileNames[i]);
209 m->mothurOut("Unable to open " + fastaFileNames[i] + ". Trying default " + tryPath); m->mothurOutEndLine();
211 ableToOpen = m->openInputFile(tryPath, in2, "noerror");
213 fastaFileNames[i] = tryPath;
217 if (ableToOpen == 1) {
218 if (m->getOutputDir() != "") { //default path is set
219 string tryPath = m->getOutputDir() + m->getSimpleName(fastaFileNames[i]);
220 m->mothurOut("Unable to open " + fastaFileNames[i] + ". Trying output directory " + tryPath); m->mothurOutEndLine();
222 ableToOpen = m->openInputFile(tryPath, in2, "noerror");
224 fastaFileNames[i] = tryPath;
230 if (ableToOpen == 1) {
231 m->mothurOut("Unable to open " + fastaFileNames[i] + ". It will be disregarded."); m->mothurOutEndLine();
232 //erase from file list
233 fastaFileNames.erase(fastaFileNames.begin()+i);
236 m->setFastaFile(fastaFileNames[i]);
242 //make sure there is at least one valid file left
243 if (fastaFileNames.size() == 0) { m->mothurOut("no valid files."); m->mothurOutEndLine(); abort = true; }
246 namefile = validParameter.validFile(parameters, "name", false);
247 if (namefile == "not found") { namefile = ""; }
250 m->splitAtDash(namefile, namefileNames);
252 //go through files and make sure they are good, if not, then disregard them
253 for (int i = 0; i < namefileNames.size(); i++) {
255 if (namefileNames[i] == "current") {
256 namefileNames[i] = m->getNameFile();
257 if (namefileNames[i] != "") { m->mothurOut("Using " + namefileNames[i] + " as input file for the name parameter where you had given current."); m->mothurOutEndLine(); }
259 m->mothurOut("You have no current namefile, ignoring current."); m->mothurOutEndLine(); ignore=true;
260 //erase from file list
261 namefileNames.erase(namefileNames.begin()+i);
268 if (inputDir != "") {
269 string path = m->hasPath(namefileNames[i]);
270 //if the user has not given a path then, add inputdir. else leave path alone.
271 if (path == "") { namefileNames[i] = inputDir + namefileNames[i]; }
276 ableToOpen = m->openInputFile(namefileNames[i], in, "noerror");
278 //if you can't open it, try default location
279 if (ableToOpen == 1) {
280 if (m->getDefaultPath() != "") { //default path is set
281 string tryPath = m->getDefaultPath() + m->getSimpleName(namefileNames[i]);
282 m->mothurOut("Unable to open " + namefileNames[i] + ". Trying default " + tryPath); m->mothurOutEndLine();
284 ableToOpen = m->openInputFile(tryPath, in2, "noerror");
286 namefileNames[i] = tryPath;
290 if (ableToOpen == 1) {
291 if (m->getOutputDir() != "") { //default path is set
292 string tryPath = m->getOutputDir() + m->getSimpleName(namefileNames[i]);
293 m->mothurOut("Unable to open " + namefileNames[i] + ". Trying output directory " + tryPath); m->mothurOutEndLine();
295 ableToOpen = m->openInputFile(tryPath, in2, "noerror");
297 namefileNames[i] = tryPath;
302 if (ableToOpen == 1) {
303 m->mothurOut("Unable to open " + namefileNames[i] + ". It will be disregarded."); m->mothurOutEndLine(); abort = true;
304 //erase from file list
305 namefileNames.erase(namefileNames.begin()+i);
308 m->setNameFile(namefileNames[i]);
314 if (namefile != "") {
315 if (namefileNames.size() != fastaFileNames.size()) { abort = true; m->mothurOut("If you provide a name file, you must have one for each fasta file."); m->mothurOutEndLine(); }
318 groupfile = validParameter.validFile(parameters, "group", false);
319 if (groupfile == "not found") { groupfile = ""; }
321 m->splitAtDash(groupfile, groupfileNames);
323 //go through files and make sure they are good, if not, then disregard them
324 for (int i = 0; i < groupfileNames.size(); i++) {
325 if (inputDir != "") {
326 string path = m->hasPath(groupfileNames[i]);
327 //if the user has not given a path then, add inputdir. else leave path alone.
328 if (path == "") { groupfileNames[i] = inputDir + groupfileNames[i]; }
333 ableToOpen = m->openInputFile(groupfileNames[i], in, "noerror");
335 //if you can't open it, try default location
336 if (ableToOpen == 1) {
337 if (m->getDefaultPath() != "") { //default path is set
338 string tryPath = m->getDefaultPath() + m->getSimpleName(groupfileNames[i]);
339 m->mothurOut("Unable to open " + groupfileNames[i] + ". Trying default " + tryPath); m->mothurOutEndLine();
341 ableToOpen = m->openInputFile(tryPath, in2, "noerror");
343 groupfileNames[i] = tryPath;
347 if (ableToOpen == 1) {
348 if (m->getOutputDir() != "") { //default path is set
349 string tryPath = m->getOutputDir() + m->getSimpleName(groupfileNames[i]);
350 m->mothurOut("Unable to open " + groupfileNames[i] + ". Trying output directory " + tryPath); m->mothurOutEndLine();
352 ableToOpen = m->openInputFile(tryPath, in2, "noerror");
354 groupfileNames[i] = tryPath;
360 if (ableToOpen == 1) {
361 m->mothurOut("Unable to open " + groupfileNames[i] + ". It will be disregarded."); m->mothurOutEndLine(); groupfileNames[i] = "";
362 //erase from file list
363 groupfileNames.erase(groupfileNames.begin()+i);
366 m->setGroupFile(groupfileNames[i]);
371 if (groupfile != "") {
372 if (groupfileNames.size() != fastaFileNames.size()) { abort = true; m->mothurOut("If you provide a group file, you must have one for each fasta file."); m->mothurOutEndLine(); }
374 for (int i = 0; i < fastaFileNames.size(); i++) { groupfileNames.push_back(""); }
377 //check for optional parameter and set defaults
378 // ...at some point should added some additional type checking...
380 temp = validParameter.validFile(parameters, "ksize", false); if (temp == "not found"){ temp = "8"; }
381 m->mothurConvert(temp, kmerSize);
383 temp = validParameter.validFile(parameters, "processors", false); if (temp == "not found"){ temp = m->getProcessors(); }
384 m->setProcessors(temp);
385 m->mothurConvert(temp, processors);
387 temp = validParameter.validFile(parameters, "save", false); if (temp == "not found"){ temp = "f"; }
388 save = m->isTrue(temp);
390 if (save) { //clear out old references
394 //this has to go after save so that if the user sets save=t and provides no reference we abort
395 templateFileName = validParameter.validFile(parameters, "reference", true);
396 if (templateFileName == "not found") {
397 //check for saved reference sequences
398 if (rdb->referenceSeqs.size() != 0) {
399 templateFileName = "saved";
401 m->mothurOut("[ERROR]: You don't have any saved reference sequences and the reference parameter is a required for the classify.seqs command.");
402 m->mothurOutEndLine();
405 }else if (templateFileName == "not open") { abort = true; }
406 else { if (save) { rdb->setSavedReference(templateFileName); } }
408 //this has to go after save so that if the user sets save=t and provides no reference we abort
409 taxonomyFileName = validParameter.validFile(parameters, "taxonomy", true);
410 if (taxonomyFileName == "not found") {
411 //check for saved reference sequences
412 if (rdb->wordGenusProb.size() != 0) {
413 taxonomyFileName = "saved";
415 m->mothurOut("[ERROR]: You don't have any saved taxonomy information and the taxonomy parameter is a required for the classify.seqs command.");
416 m->mothurOutEndLine();
419 }else if (taxonomyFileName == "not open") { abort = true; }
420 else { if (save) { rdb->setSavedTaxonomy(taxonomyFileName); } }
422 search = validParameter.validFile(parameters, "search", false); if (search == "not found"){ search = "kmer"; }
424 method = validParameter.validFile(parameters, "method", false); if (method == "not found"){ method = "bayesian"; }
426 temp = validParameter.validFile(parameters, "match", false); if (temp == "not found"){ temp = "1.0"; }
427 m->mothurConvert(temp, match);
429 temp = validParameter.validFile(parameters, "mismatch", false); if (temp == "not found"){ temp = "-1.0"; }
430 m->mothurConvert(temp, misMatch);
432 temp = validParameter.validFile(parameters, "gapopen", false); if (temp == "not found"){ temp = "-2.0"; }
433 m->mothurConvert(temp, gapOpen);
435 temp = validParameter.validFile(parameters, "gapextend", false); if (temp == "not found"){ temp = "-1.0"; }
436 m->mothurConvert(temp, gapExtend);
438 temp = validParameter.validFile(parameters, "numwanted", false); if (temp == "not found"){ temp = "10"; }
439 m->mothurConvert(temp, numWanted);
441 temp = validParameter.validFile(parameters, "cutoff", false); if (temp == "not found"){ temp = "0"; }
442 m->mothurConvert(temp, cutoff);
444 temp = validParameter.validFile(parameters, "probs", false); if (temp == "not found"){ temp = "true"; }
445 probs = m->isTrue(temp);
447 //temp = validParameter.validFile(parameters, "flip", false); if (temp == "not found"){ temp = "T"; }
448 //flip = m->isTrue(temp);
451 temp = validParameter.validFile(parameters, "iters", false); if (temp == "not found") { temp = "100"; }
452 m->mothurConvert(temp, iters);
455 if ((method == "bayesian") && (search != "kmer")) {
456 m->mothurOut("The bayesian method requires the kmer search." + search + "will be disregarded." ); m->mothurOutEndLine();
461 if (namefileNames.size() == 0){
462 if (fastaFileNames.size() != 0) {
463 vector<string> files; files.push_back(fastaFileNames[fastaFileNames.size()-1]);
464 parser.getNameFile(files);
472 catch(exception& e) {
473 m->errorOut(e, "ClassifySeqsCommand", "ClassifySeqsCommand");
478 //**********************************************************************************************************************
479 ClassifySeqsCommand::~ClassifySeqsCommand(){
480 if (abort == false) {
481 for (int i = 0; i < lines.size(); i++) { delete lines[i]; } lines.clear();
484 //**********************************************************************************************************************
486 int ClassifySeqsCommand::execute(){
488 if (abort == true) { if (calledHelp) { return 0; } return 2; }
490 if(method == "bayesian"){ classify = new Bayesian(taxonomyFileName, templateFileName, search, kmerSize, cutoff, iters, rand(), flip); }
491 else if(method == "knn"){ classify = new Knn(taxonomyFileName, templateFileName, search, kmerSize, gapOpen, gapExtend, match, misMatch, numWanted, rand()); }
493 m->mothurOut(search + " is not a valid method option. I will run the command using bayesian.");
494 m->mothurOutEndLine();
495 classify = new Bayesian(taxonomyFileName, templateFileName, search, kmerSize, cutoff, iters, rand(), flip);
498 if (m->control_pressed) { delete classify; return 0; }
500 for (int s = 0; s < fastaFileNames.size(); s++) {
502 m->mothurOut("Classifying sequences from " + fastaFileNames[s] + " ..." ); m->mothurOutEndLine();
504 string baseTName = taxonomyFileName;
505 if (taxonomyFileName == "saved") {baseTName = rdb->getSavedTaxonomy(); }
507 string RippedTaxName = m->getRootName(m->getSimpleName(baseTName));
508 RippedTaxName = m->getExtension(RippedTaxName.substr(0, RippedTaxName.length()-1));
509 if (RippedTaxName[0] == '.') { RippedTaxName = RippedTaxName.substr(1, RippedTaxName.length()); }
510 RippedTaxName += ".";
512 if (outputDir == "") { outputDir += m->hasPath(fastaFileNames[s]); }
513 string newTaxonomyFile = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[s])) + RippedTaxName + "taxonomy";
514 string newaccnosFile = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[s])) + RippedTaxName + "flip.accnos";
515 string tempTaxonomyFile = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[s])) + "taxonomy.temp";
516 string taxSummary = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[s])) + RippedTaxName + "tax.summary";
518 if ((method == "knn") && (search == "distance")) {
519 string DistName = outputDir + m->getRootName(m->getSimpleName(fastaFileNames[s])) + "match.dist";
520 classify->setDistName(DistName); outputNames.push_back(DistName); outputTypes["matchdist"].push_back(DistName);
523 outputNames.push_back(newTaxonomyFile); outputTypes["taxonomy"].push_back(newTaxonomyFile);
524 outputNames.push_back(newaccnosFile); outputTypes["accnos"].push_back(newaccnosFile);
525 outputNames.push_back(taxSummary); outputTypes["taxsummary"].push_back(taxSummary);
527 int start = time(NULL);
528 int numFastaSeqs = 0;
529 for (int i = 0; i < lines.size(); i++) { delete lines[i]; } lines.clear();
532 int pid, numSeqsPerProcessor;
534 vector<unsigned long long> MPIPos;
537 MPI_Comm_rank(MPI_COMM_WORLD, &pid); //find out who we are
538 MPI_Comm_size(MPI_COMM_WORLD, &processors);
541 MPI_File outMPINewTax;
542 MPI_File outMPITempTax;
545 int outMode=MPI_MODE_CREATE|MPI_MODE_WRONLY;
546 int inMode=MPI_MODE_RDONLY;
548 char outNewTax[1024];
549 strcpy(outNewTax, newTaxonomyFile.c_str());
551 char outTempTax[1024];
552 strcpy(outTempTax, tempTaxonomyFile.c_str());
555 strcpy(outAcc, newaccnosFile.c_str());
557 char inFileName[1024];
558 strcpy(inFileName, fastaFileNames[s].c_str());
560 MPI_File_open(MPI_COMM_WORLD, inFileName, inMode, MPI_INFO_NULL, &inMPI); //comm, filename, mode, info, filepointer
561 MPI_File_open(MPI_COMM_WORLD, outNewTax, outMode, MPI_INFO_NULL, &outMPINewTax);
562 MPI_File_open(MPI_COMM_WORLD, outTempTax, outMode, MPI_INFO_NULL, &outMPITempTax);
563 MPI_File_open(MPI_COMM_WORLD, outAcc, outMode, MPI_INFO_NULL, &outMPIAcc);
565 if (m->control_pressed) { outputTypes.clear(); MPI_File_close(&inMPI); MPI_File_close(&outMPINewTax); MPI_File_close(&outMPIAcc); MPI_File_close(&outMPITempTax); delete classify; return 0; }
567 if (pid == 0) { //you are the root process
569 MPIPos = m->setFilePosFasta(fastaFileNames[s], numFastaSeqs); //fills MPIPos, returns numSeqs
571 //send file positions to all processes
572 for(int i = 1; i < processors; i++) {
573 MPI_Send(&numFastaSeqs, 1, MPI_INT, i, tag, MPI_COMM_WORLD);
574 MPI_Send(&MPIPos[0], (numFastaSeqs+1), MPI_LONG, i, tag, MPI_COMM_WORLD);
577 //figure out how many sequences you have to align
578 numSeqsPerProcessor = numFastaSeqs / processors;
579 int startIndex = pid * numSeqsPerProcessor;
580 if(pid == (processors - 1)){ numSeqsPerProcessor = numFastaSeqs - pid * numSeqsPerProcessor; }
584 driverMPI(startIndex, numSeqsPerProcessor, inMPI, outMPINewTax, outMPITempTax, outMPIAcc, MPIPos);
586 if (m->control_pressed) { outputTypes.clear(); MPI_File_close(&inMPI); MPI_File_close(&outMPINewTax); MPI_File_close(&outMPIAcc); MPI_File_close(&outMPITempTax); for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); } delete classify; return 0; }
588 for (int i = 1; i < processors; i++) {
590 MPI_Recv(&done, 1, MPI_INT, i, tag, MPI_COMM_WORLD, &status);
592 }else{ //you are a child process
593 MPI_Recv(&numFastaSeqs, 1, MPI_INT, 0, tag, MPI_COMM_WORLD, &status);
594 MPIPos.resize(numFastaSeqs+1);
595 MPI_Recv(&MPIPos[0], (numFastaSeqs+1), MPI_LONG, 0, tag, MPI_COMM_WORLD, &status);
597 //figure out how many sequences you have to align
598 numSeqsPerProcessor = numFastaSeqs / processors;
599 int startIndex = pid * numSeqsPerProcessor;
600 if(pid == (processors - 1)){ numSeqsPerProcessor = numFastaSeqs - pid * numSeqsPerProcessor; }
604 driverMPI(startIndex, numSeqsPerProcessor, inMPI, outMPINewTax, outMPITempTax, outMPIAcc, MPIPos);
606 if (m->control_pressed) { outputTypes.clear(); MPI_File_close(&inMPI); MPI_File_close(&outMPINewTax); MPI_File_close(&outMPIAcc); MPI_File_close(&outMPITempTax); delete classify; return 0; }
609 MPI_Send(&done, 1, MPI_INT, 0, tag, MPI_COMM_WORLD);
613 MPI_File_close(&inMPI);
614 MPI_File_close(&outMPINewTax);
615 MPI_File_close(&outMPITempTax);
616 MPI_File_close(&outMPIAcc);
617 MPI_Barrier(MPI_COMM_WORLD); //make everyone wait - just in case
621 vector<unsigned long long> positions;
622 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux) || (__linux__) || (__unix__) || (__unix)
623 positions = m->divideFile(fastaFileNames[s], processors);
624 for (int i = 0; i < (positions.size()-1); i++) { lines.push_back(new linePair(positions[i], positions[(i+1)])); }
626 if (processors == 1) {
627 lines.push_back(new linePair(0, 1000));
629 positions = m->setFilePosFasta(fastaFileNames[s], numFastaSeqs);
630 if (positions.size() < processors) { processors = positions.size(); }
632 //figure out how many sequences you have to process
633 int numSeqsPerProcessor = numFastaSeqs / processors;
634 for (int i = 0; i < processors; i++) {
635 int startIndex = i * numSeqsPerProcessor;
636 if(i == (processors - 1)){ numSeqsPerProcessor = numFastaSeqs - i * numSeqsPerProcessor; }
637 lines.push_back(new linePair(positions[startIndex], numSeqsPerProcessor));
642 numFastaSeqs = driver(lines[0], newTaxonomyFile, tempTaxonomyFile, newaccnosFile, fastaFileNames[s]);
644 numFastaSeqs = createProcesses(newTaxonomyFile, tempTaxonomyFile, newaccnosFile, fastaFileNames[s]);
648 if (!m->isBlank(newaccnosFile)) { m->mothurOutEndLine(); m->mothurOut("[WARNING]: mothur suspects some of your sequences may be reversed, please check " + newaccnosFile + " for the list of the sequences."); m->mothurOutEndLine(); }
650 m->mothurOutEndLine();
651 m->mothurOut("It took " + toString(time(NULL) - start) + " secs to classify " + toString(numFastaSeqs) + " sequences."); m->mothurOutEndLine(); m->mothurOutEndLine();
657 if (pid == 0) { //this part does not need to be paralellized
659 if(namefile != "") { m->mothurOut("Reading " + namefileNames[s] + "..."); cout.flush(); MPIReadNamesFile(namefileNames[s]); m->mothurOut(" Done."); m->mothurOutEndLine(); }
664 m->mothurOut("Reading " + namefileNames[s] + "..."); cout.flush();
666 nameMap.clear(); //remove old names
669 m->openInputFile(namefileNames[s], inNames);
671 string firstCol, secondCol;
672 while(!inNames.eof()) {
673 inNames >> firstCol >> secondCol; m->gobble(inNames);
676 m->splitAtComma(secondCol, temp);
678 nameMap[firstCol] = temp;
682 m->mothurOut(" Done."); m->mothurOutEndLine();
687 if (groupfile != "") { group = groupfileNames[s]; }
689 PhyloSummary taxaSum(baseTName, group);
691 if (m->control_pressed) { outputTypes.clear(); for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); } delete classify; return 0; }
693 if (namefile == "") { taxaSum.summarize(tempTaxonomyFile); }
696 m->openInputFile(tempTaxonomyFile, in);
698 //read in users taxonomy file and add sequences to tree
702 in >> name >> taxon; m->gobble(in);
704 itNames = nameMap.find(name);
706 if (itNames == nameMap.end()) {
707 m->mothurOut(name + " is not in your name file please correct."); m->mothurOutEndLine(); exit(1);
709 for (int i = 0; i < itNames->second.size(); i++) {
710 taxaSum.addSeqToTree(itNames->second[i], taxon); //add it as many times as there are identical seqs
712 itNames->second.clear();
713 nameMap.erase(itNames->first);
718 m->mothurRemove(tempTaxonomyFile);
720 if (m->control_pressed) { outputTypes.clear(); for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); } delete classify; return 0; }
724 m->openOutputFile(taxSummary, outTaxTree);
725 taxaSum.print(outTaxTree);
728 //output taxonomy with the unclassified bins added
730 m->openInputFile(newTaxonomyFile, inTax);
733 string unclass = newTaxonomyFile + ".unclass.temp";
734 m->openOutputFile(unclass, outTax);
736 //get maxLevel from phylotree so you know how many 'unclassified's to add
737 int maxLevel = taxaSum.getMaxLevel();
739 //read taxfile - this reading and rewriting is done to preserve the confidence scores.
741 while (!inTax.eof()) {
742 if (m->control_pressed) { outputTypes.clear(); for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); } m->mothurRemove(unclass); delete classify; return 0; }
744 inTax >> name >> taxon; m->gobble(inTax);
746 string newTax = addUnclassifieds(taxon, maxLevel);
748 outTax << name << '\t' << newTax << endl;
753 m->mothurRemove(newTaxonomyFile);
754 rename(unclass.c_str(), newTaxonomyFile.c_str());
756 m->mothurOutEndLine();
757 m->mothurOut("It took " + toString(time(NULL) - start) + " secs to create the summary file for " + toString(numFastaSeqs) + " sequences."); m->mothurOutEndLine(); m->mothurOutEndLine();
763 m->mothurOutEndLine();
764 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
765 for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i]); m->mothurOutEndLine(); }
766 m->mothurOutEndLine();
769 //set taxonomy file as new current taxonomyfile
771 itTypes = outputTypes.find("taxonomy");
772 if (itTypes != outputTypes.end()) {
773 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setTaxonomyFile(current); }
777 itTypes = outputTypes.find("accnos");
778 if (itTypes != outputTypes.end()) {
779 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setAccnosFile(current); }
786 catch(exception& e) {
787 m->errorOut(e, "ClassifySeqsCommand", "execute");
792 /**************************************************************************************************/
793 string ClassifySeqsCommand::addUnclassifieds(string tax, int maxlevel) {
795 string newTax, taxon;
798 //keep what you have counting the levels
799 while (tax.find_first_of(';') != -1) {
801 taxon = tax.substr(0,tax.find_first_of(';'))+';';
802 tax = tax.substr(tax.find_first_of(';')+1, tax.length());
807 //add "unclassified" until you reach maxLevel
808 while (level < maxlevel) {
809 newTax += "unclassified;";
815 catch(exception& e) {
816 m->errorOut(e, "ClassifySeqsCommand", "addUnclassifieds");
821 /**************************************************************************************************/
823 int ClassifySeqsCommand::createProcesses(string taxFileName, string tempTaxFile, string accnos, string filename) {
829 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux) || (__linux__) || (__unix__) || (__unix)
832 //loop through and create all the processes you want
833 while (process != processors) {
837 processIDS.push_back(pid); //create map from line number to pid so you can append files in correct order later
840 num = driver(lines[process], taxFileName + toString(getpid()) + ".temp", tempTaxFile + toString(getpid()) + ".temp", accnos + toString(getpid()) + ".temp", filename);
842 //pass numSeqs to parent
844 string tempFile = filename + toString(getpid()) + ".num.temp";
845 m->openOutputFile(tempFile, out);
851 m->mothurOut("[ERROR]: unable to spawn the necessary processes."); m->mothurOutEndLine();
852 for (int i = 0; i < processIDS.size(); i++) { kill (processIDS[i], SIGINT); }
857 //parent does its part
858 num = driver(lines[0], taxFileName, tempTaxFile, accnos, filename);
860 //force parent to wait until all the processes are done
861 for (int i=0;i<processIDS.size();i++) {
862 int temp = processIDS[i];
866 for (int i = 0; i < processIDS.size(); i++) {
868 string tempFile = filename + toString(processIDS[i]) + ".num.temp";
869 m->openInputFile(tempFile, in);
870 if (!in.eof()) { int tempNum = 0; in >> tempNum; num += tempNum; }
871 in.close(); m->mothurRemove(m->getFullPathName(tempFile));
874 //////////////////////////////////////////////////////////////////////////////////////////////////////
875 //Windows version shared memory, so be careful when passing variables through the alignData struct.
876 //Above fork() will clone, so memory is separate, but that's not the case with windows,
877 //////////////////////////////////////////////////////////////////////////////////////////////////////
879 vector<classifyData*> pDataArray;
880 DWORD dwThreadIdArray[processors-1];
881 HANDLE hThreadArray[processors-1];
883 //Create processor worker threads.
884 for( int i=0; i<processors-1; i++ ){
885 // Allocate memory for thread data.
886 string extension = "";
887 if (i != 0) { extension = toString(i) + ".temp"; processIDS.push_back(i); }
889 classifyData* tempclass = new classifyData((accnos + extension), probs, method, templateFileName, taxonomyFileName, (taxFileName + extension), (tempTaxFile + extension), filename, search, kmerSize, iters, numWanted, m, lines[i]->start, lines[i]->end, match, misMatch, gapOpen, gapExtend, cutoff, i, flip);
890 pDataArray.push_back(tempclass);
892 //MySeqSumThreadFunction is in header. It must be global or static to work with the threads.
893 //default security attributes, thread function name, argument to thread function, use default creation flags, returns the thread identifier
894 hThreadArray[i] = CreateThread(NULL, 0, MyClassThreadFunction, pDataArray[i], 0, &dwThreadIdArray[i]);
898 //parent does its part
899 num = driver(lines[processors-1], taxFileName + toString(processors-1) + ".temp", tempTaxFile + toString(processors-1) + ".temp", accnos + toString(processors-1) + ".temp", filename);
900 processIDS.push_back((processors-1));
902 //Wait until all threads have terminated.
903 WaitForMultipleObjects(processors-1, hThreadArray, TRUE, INFINITE);
905 //Close all thread handles and free memory allocations.
906 for(int i=0; i < pDataArray.size(); i++){
907 num += pDataArray[i]->count;
908 CloseHandle(hThreadArray[i]);
909 delete pDataArray[i];
913 vector<string> nonBlankAccnosFiles;
914 if (!(m->isBlank(accnos))) { nonBlankAccnosFiles.push_back(accnos); }
915 else { m->mothurRemove(accnos); } //remove so other files can be renamed to it
917 for(int i=0;i<processIDS.size();i++){
918 appendTaxFiles((taxFileName + toString(processIDS[i]) + ".temp"), taxFileName);
919 appendTaxFiles((tempTaxFile + toString(processIDS[i]) + ".temp"), tempTaxFile);
920 if (!(m->isBlank(accnos + toString(processIDS[i]) + ".temp"))) {
921 nonBlankAccnosFiles.push_back(accnos + toString(processIDS[i]) + ".temp");
922 }else { m->mothurRemove((accnos + toString(processIDS[i]) + ".temp")); }
924 m->mothurRemove((m->getFullPathName(taxFileName) + toString(processIDS[i]) + ".temp"));
925 m->mothurRemove((m->getFullPathName(tempTaxFile) + toString(processIDS[i]) + ".temp"));
928 //append accnos files
929 if (nonBlankAccnosFiles.size() != 0) {
930 rename(nonBlankAccnosFiles[0].c_str(), accnos.c_str());
932 for (int h=1; h < nonBlankAccnosFiles.size(); h++) {
933 appendTaxFiles(nonBlankAccnosFiles[h], accnos);
934 m->mothurRemove(nonBlankAccnosFiles[h]);
936 }else { //recreate the accnosfile if needed
938 m->openOutputFile(accnos, out);
945 catch(exception& e) {
946 m->errorOut(e, "ClassifySeqsCommand", "createProcesses");
950 /**************************************************************************************************/
952 void ClassifySeqsCommand::appendTaxFiles(string temp, string filename) {
957 m->openOutputFileAppend(filename, output);
958 m->openInputFile(temp, input);
960 while(char c = input.get()){
961 if(input.eof()) { break; }
962 else { output << c; }
968 catch(exception& e) {
969 m->errorOut(e, "ClassifySeqsCommand", "appendTaxFiles");
974 //**********************************************************************************************************************
976 int ClassifySeqsCommand::driver(linePair* filePos, string taxFName, string tempTFName, string accnos, string filename){
979 m->openOutputFile(taxFName, outTax);
981 ofstream outTaxSimple;
982 m->openOutputFile(tempTFName, outTaxSimple);
985 m->openOutputFile(accnos, outAcc);
988 m->openInputFile(filename, inFASTA);
992 inFASTA.seekg(filePos->start);
998 if (m->control_pressed) {
1001 outTaxSimple.close();
1002 outAcc.close(); return 0; }
1004 Sequence* candidateSeq = new Sequence(inFASTA); m->gobble(inFASTA);
1006 if (candidateSeq->getName() != "") {
1008 taxonomy = classify->getTaxonomy(candidateSeq);
1010 if (m->control_pressed) { delete candidateSeq; return 0; }
1012 if (taxonomy == "unknown;") { m->mothurOut("[WARNING]: " + candidateSeq->getName() + " could not be classified. You can use the remove.lineage command with taxon=unknown; to remove such sequences."); m->mothurOutEndLine(); }
1014 //output confidence scores or not
1016 outTax << candidateSeq->getName() << '\t' << taxonomy << endl;
1018 outTax << candidateSeq->getName() << '\t' << classify->getSimpleTax() << endl;
1021 if (classify->getFlipped()) { outAcc << candidateSeq->getName() << endl; }
1023 outTaxSimple << candidateSeq->getName() << '\t' << classify->getSimpleTax() << endl;
1027 delete candidateSeq;
1029 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux) || (__linux__) || (__unix__) || (__unix)
1030 unsigned long long pos = inFASTA.tellg();
1031 if ((pos == -1) || (pos >= filePos->end)) { break; }
1033 if (inFASTA.eof()) { break; }
1037 if((count) % 100 == 0){ m->mothurOut("Processing sequence: " + toString(count)); m->mothurOutEndLine(); }
1041 if((count) % 100 != 0){ m->mothurOut("Processing sequence: " + toString(count)); m->mothurOutEndLine(); }
1045 outTaxSimple.close();
1050 catch(exception& e) {
1051 m->errorOut(e, "ClassifySeqsCommand", "driver");
1055 //**********************************************************************************************************************
1057 int ClassifySeqsCommand::driverMPI(int start, int num, MPI_File& inMPI, MPI_File& newFile, MPI_File& tempFile, MPI_File& accFile, vector<unsigned long long>& MPIPos){
1059 MPI_Status statusNew;
1060 MPI_Status statusTemp;
1061 MPI_Status statusAcc;
1065 MPI_Comm_rank(MPI_COMM_WORLD, &pid); //find out who we are
1068 string outputString;
1070 for(int i=0;i<num;i++){
1072 if (m->control_pressed) { return 0; }
1074 //read next sequence
1075 int length = MPIPos[start+i+1] - MPIPos[start+i];
1076 char* buf4 = new char[length];
1077 MPI_File_read_at(inMPI, MPIPos[start+i], buf4, length, MPI_CHAR, &status);
1079 string tempBuf = buf4;
1080 if (tempBuf.length() > length) { tempBuf = tempBuf.substr(0, length); }
1081 istringstream iss (tempBuf,istringstream::in);
1084 Sequence* candidateSeq = new Sequence(iss);
1086 if (candidateSeq->getName() != "") {
1087 taxonomy = classify->getTaxonomy(candidateSeq);
1089 if (taxonomy == "unknown;") { m->mothurOut("[WARNING]: " + candidateSeq->getName() + " could not be classified. You can use the remove.lineage command with taxon=unknown; to remove such sequences."); m->mothurOutEndLine(); }
1091 //output confidence scores or not
1093 outputString = candidateSeq->getName() + "\t" + taxonomy + "\n";
1095 outputString = candidateSeq->getName() + "\t" + classify->getSimpleTax() + "\n";
1098 int length = outputString.length();
1099 char* buf2 = new char[length];
1100 memcpy(buf2, outputString.c_str(), length);
1102 MPI_File_write_shared(newFile, buf2, length, MPI_CHAR, &statusNew);
1105 outputString = candidateSeq->getName() + "\t" + classify->getSimpleTax() + "\n";
1106 length = outputString.length();
1107 char* buf = new char[length];
1108 memcpy(buf, outputString.c_str(), length);
1110 MPI_File_write_shared(tempFile, buf, length, MPI_CHAR, &statusTemp);
1113 if (classify->getFlipped()) {
1114 outputString = candidateSeq->getName() + "\n";
1115 length = outputString.length();
1116 char* buf3 = new char[length];
1117 memcpy(buf3, outputString.c_str(), length);
1119 MPI_File_write_shared(accFile, buf3, length, MPI_CHAR, &statusAcc);
1124 delete candidateSeq;
1126 if((i+1) % 100 == 0){ cout << "Classifying sequence " << (i+1) << endl; }
1129 if(num % 100 != 0){ cout << "Classifying sequence " << (num) << endl; }
1134 catch(exception& e) {
1135 m->errorOut(e, "ClassifySeqsCommand", "driverMPI");
1140 //**********************************************************************************************************************
1141 int ClassifySeqsCommand::MPIReadNamesFile(string nameFilename){
1144 nameMap.clear(); //remove old names
1150 //char* inFileName = new char[nameFilename.length()];
1151 //memcpy(inFileName, nameFilename.c_str(), nameFilename.length());
1153 char inFileName[1024];
1154 strcpy(inFileName, nameFilename.c_str());
1156 MPI_File_open(MPI_COMM_WORLD, inFileName, MPI_MODE_RDONLY, MPI_INFO_NULL, &inMPI);
1157 MPI_File_get_size(inMPI, &size);
1158 //delete inFileName;
1160 char* buffer = new char[size];
1161 MPI_File_read(inMPI, buffer, size, MPI_CHAR, &status);
1163 string tempBuf = buffer;
1164 if (tempBuf.length() > size) { tempBuf = tempBuf.substr(0, size); }
1165 istringstream iss (tempBuf,istringstream::in);
1168 string firstCol, secondCol;
1170 iss >> firstCol >> secondCol; m->gobble(iss);
1172 vector<string> temp;
1173 m->splitAtComma(secondCol, temp);
1175 nameMap[firstCol] = temp;
1178 MPI_File_close(&inMPI);
1182 catch(exception& e) {
1183 m->errorOut(e, "ClassifySeqsCommand", "MPIReadNamesFile");
1188 /**************************************************************************************************/