5 * Created by Sarah Westcott on 5/7/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "distancecommand.h"
11 #include "ignoregaps.h"
12 #include "eachgapdist.h"
13 #include "eachgapignore.h"
14 #include "onegapdist.h"
15 #include "onegapignore.h"
17 //**********************************************************************************************************************
19 DistanceCommand::DistanceCommand(string option) {
24 //allow user to run help
25 if(option == "help") { help(); abort = true; }
28 //valid paramters for this command
29 string Array[] = {"fasta", "output", "calc", "countends", "cutoff", "processors", "outputdir","inputdir"};
30 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
32 OptionParser parser(option);
33 map<string, string> parameters = parser.getParameters();
35 ValidParameters validParameter;
36 map<string, string>::iterator it2;
38 //check to make sure all parameters are valid for command
39 for (it2 = parameters.begin(); it2 != parameters.end(); it2++) {
40 if (validParameter.isValidParameter(it2->first, myArray, it2->second) != true) { abort = true; }
43 //if the user changes the input directory command factory will send this info to us in the output parameter
44 string inputDir = validParameter.validFile(parameters, "inputdir", false);
45 if (inputDir == "not found"){ inputDir = ""; }
48 it2 = parameters.find("fasta");
49 //user has given a template file
50 if(it2 != parameters.end()){
51 path = hasPath(it2->second);
52 //if the user has not given a path then, add inputdir. else leave path alone.
53 if (path == "") { parameters["fasta"] = inputDir + it2->second; }
57 //check for required parameters
58 fastafile = validParameter.validFile(parameters, "fasta", true);
59 if (fastafile == "not found") { m->mothurOut("fasta is a required parameter for the dist.seqs command."); m->mothurOutEndLine(); abort = true; }
60 else if (fastafile == "not open") { abort = true; }
63 openInputFile(fastafile, inFASTA);
64 alignDB = SequenceDB(inFASTA);
68 //if the user changes the output directory command factory will send this info to us in the output parameter
69 outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){
71 outputDir += hasPath(fastafile); //if user entered a file with a path then preserve it
74 //check for optional parameter and set defaults
75 // ...at some point should added some additional type checking...
76 calc = validParameter.validFile(parameters, "calc", false);
77 if (calc == "not found") { calc = "onegap"; }
79 if (calc == "default") { calc = "onegap"; }
81 splitAtDash(calc, Estimators);
84 temp = validParameter.validFile(parameters, "countends", false); if(temp == "not found"){ temp = "T"; }
85 convert(temp, countends);
87 temp = validParameter.validFile(parameters, "cutoff", false); if(temp == "not found"){ temp = "1.0"; }
88 convert(temp, cutoff);
90 temp = validParameter.validFile(parameters, "processors", false); if(temp == "not found"){ temp = "1"; }
91 convert(temp, processors);
93 output = validParameter.validFile(parameters, "output", false); if(output == "not found"){ output = "column"; }
95 if ((output != "column") && (output != "lt") && (output != "square")) { m->mothurOut(output + " is not a valid output form. Options are column, lt and square. I will use column."); m->mothurOutEndLine(); output = "column"; }
97 ValidCalculators validCalculator;
99 if (isTrue(countends) == true) {
100 for (int i=0; i<Estimators.size(); i++) {
101 if (validCalculator.isValidCalculator("distance", Estimators[i]) == true) {
102 if (Estimators[i] == "nogaps") { distCalculator = new ignoreGaps(); }
103 else if (Estimators[i] == "eachgap") { distCalculator = new eachGapDist(); }
104 else if (Estimators[i] == "onegap") { distCalculator = new oneGapDist(); }
108 for (int i=0; i<Estimators.size(); i++) {
109 if (validCalculator.isValidCalculator("distance", Estimators[i]) == true) {
110 if (Estimators[i] == "nogaps") { distCalculator = new ignoreGaps(); }
111 else if (Estimators[i] == "eachgap"){ distCalculator = new eachGapIgnoreTermGapDist(); }
112 else if (Estimators[i] == "onegap") { distCalculator = new oneGapIgnoreTermGapDist(); }
120 catch(exception& e) {
121 m->errorOut(e, "DistanceCommand", "DistanceCommand");
126 //**********************************************************************************************************************
128 DistanceCommand::~DistanceCommand(){
130 for(int i=0;i<lines.size();i++){
136 //**********************************************************************************************************************
138 void DistanceCommand::help(){
140 m->mothurOut("The dist.seqs command reads a file containing sequences and creates a distance file.\n");
141 m->mothurOut("The dist.seqs command parameters are fasta, calc, countends, output, cutoff and processors. \n");
142 m->mothurOut("The fasta parameter is required.\n");
143 m->mothurOut("The calc parameter allows you to specify the method of calculating the distances. Your options are: nogaps, onegap or eachgap. The default is onegap.\n");
144 m->mothurOut("The countends parameter allows you to specify whether to include terminal gaps in distance. Your options are: T or F. The default is T.\n");
145 m->mothurOut("The cutoff parameter allows you to specify maximum distance to keep. The default is 1.0.\n");
146 m->mothurOut("The output parameter allows you to specify format of your distance matrix. Options are column, lt, and square. The default is column.\n");
147 m->mothurOut("The processors parameter allows you to specify number of processors to use. The default is 1.\n");
148 m->mothurOut("The dist.seqs command should be in the following format: \n");
149 m->mothurOut("dist.seqs(fasta=yourFastaFile, calc=yourCalc, countends=yourEnds, cutoff= yourCutOff, processors=yourProcessors) \n");
150 m->mothurOut("Example dist.seqs(fasta=amazon.fasta, calc=eachgap, countends=F, cutoff= 2.0, processors=3).\n");
151 m->mothurOut("Note: No spaces between parameter labels (i.e. calc), '=' and parameters (i.e.yourCalc).\n\n");
153 catch(exception& e) {
154 m->errorOut(e, "DistanceCommand", "help");
158 //**********************************************************************************************************************
160 int DistanceCommand::execute(){
163 if (abort == true) { return 0; }
165 int startTime = time(NULL);
167 int numSeqs = alignDB.getNumSeqs();
172 if (output == "lt") { //does the user want lower triangle phylip formatted file
173 outputFile = outputDir + getRootName(getSimpleName(fastafile)) + "phylip.dist";
174 remove(outputFile.c_str());
176 //output numSeqs to phylip formatted dist file
177 }else if (output == "column") { //user wants column format
178 outputFile = outputDir + getRootName(getSimpleName(fastafile)) + "dist";
179 remove(outputFile.c_str());
180 }else { //assume square
181 outputFile = outputDir + getRootName(getSimpleName(fastafile)) + "square.dist";
182 remove(outputFile.c_str());
192 MPI_Comm_size(MPI_COMM_WORLD, &processors); //set processors to the number of mpi processes running
193 MPI_Comm_rank(MPI_COMM_WORLD, &pid); //find out who we are
195 //each process gets where it should start and stop in the file
196 start = int (sqrt(float(pid)/float(processors)) * numSeqs);
197 end = int (sqrt(float(pid+1)/float(processors)) * numSeqs);
199 if (output != "lt") {
201 int amode=MPI_MODE_CREATE|MPI_MODE_WRONLY;
203 char filename[outputFile.length()];
204 strcpy(filename, outputFile.c_str());
206 MPI_File_open(MPI_COMM_WORLD, filename, amode, MPI_INFO_NULL, &outMPI);
208 if (m->control_pressed) { MPI_File_close(&outMPI); delete distCalculator; return 0; }
210 if (pid == 0) { //you are the root process
214 driverMPI(start, end, outMPI, cutoff);
216 if (m->control_pressed) { MPI_File_close(&outMPI); delete distCalculator; return 0; }
219 for(int i = 1; i < processors; i++) {
220 if (m->control_pressed) { MPI_File_close(&outMPI); delete distCalculator; return 0; }
223 MPI_Recv(buf, 4, MPI_CHAR, i, tag, MPI_COMM_WORLD, &status);
225 }else { //you are a child process
227 driverMPI(start, end, outMPI, cutoff);
229 if (m->control_pressed) { MPI_File_close(&outMPI); delete distCalculator; return 0; }
233 //tell parent you are done.
234 MPI_Send(buf, 4, MPI_CHAR, 0, tag, MPI_COMM_WORLD);
237 MPI_File_close(&outMPI);
239 }else { //lower triangle format
240 if (pid == 0) { //you are the root process
245 driverMPI(start, end, outputFile, mySize);
247 if (m->control_pressed) { delete distCalculator; return 0; }
249 int amode=MPI_MODE_APPEND|MPI_MODE_WRONLY|MPI_MODE_CREATE; //
253 char filename[outputFile.length()];
254 strcpy(filename, outputFile.c_str());
256 MPI_File_open(MPI_COMM_SELF, filename, amode, MPI_INFO_NULL, &outMPI);
259 for(int b = 1; b < processors; b++) {
262 if (m->control_pressed) { MPI_File_close(&outMPI); delete distCalculator; return 0; }
264 MPI_Recv(&fileSize, 1, MPI_LONG, b, tag, MPI_COMM_WORLD, &status);
266 string outTemp = outputFile + toString(b) + ".temp";
267 char buf[outTemp.length()];
268 strcpy(buf, outTemp.c_str());
270 MPI_File_open(MPI_COMM_SELF, buf, MPI_MODE_DELETE_ON_CLOSE|MPI_MODE_RDONLY, MPI_INFO_NULL, &inMPI);
273 while (count < fileSize) { //read 1000 characters at a time
276 MPI_File_read(inMPI, buf2, 1, MPI_CHAR, &status);
277 MPI_File_write(outMPI, buf2, 1, MPI_CHAR, &status);
281 MPI_File_close(&inMPI); //deleted on close
284 MPI_File_close(&outMPI);
285 }else { //you are a child process
288 driverMPI(start, end, (outputFile + toString(pid) + ".temp"), size);
290 if (m->control_pressed) { delete distCalculator; return 0; }
292 //tell parent you are done.
293 MPI_Send(&size, 1, MPI_LONG, 0, tag, MPI_COMM_WORLD);
298 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
299 //if you don't need to fork anything
301 driver(0, numSeqs, outputFile, cutoff);
302 }else{ //you have multiple processors
304 for (int i = 0; i < processors; i++) {
305 lines.push_back(new linePair());
306 lines[i]->start = int (sqrt(float(i)/float(processors)) * numSeqs);
307 lines[i]->end = int (sqrt(float(i+1)/float(processors)) * numSeqs);
310 createProcesses(outputFile);
312 map<int, int>::iterator it = processIDS.begin();
313 rename((outputFile + toString(it->second) + ".temp").c_str(), outputFile.c_str());
316 //append and remove temp files
317 for (; it != processIDS.end(); it++) {
318 appendFiles((outputFile + toString(it->second) + ".temp"), outputFile);
319 remove((outputFile + toString(it->second) + ".temp").c_str());
324 driver(0, numSeqs, outputFile, cutoff);
328 if (m->control_pressed) { delete distCalculator; remove(outputFile.c_str()); return 0; }
331 MPI_Comm_rank(MPI_COMM_WORLD, &pid);
333 if (pid == 0) { //only one process should output to screen
336 if (output == "square") { convertMatrix(outputFile); }
342 if (m->control_pressed) { delete distCalculator; remove(outputFile.c_str()); return 0; }
344 delete distCalculator;
346 m->mothurOutEndLine();
347 m->mothurOut("Output File Name: "); m->mothurOutEndLine();
348 m->mothurOut(outputFile); m->mothurOutEndLine();
349 m->mothurOutEndLine();
350 m->mothurOut("It took " + toString(time(NULL) - startTime) + " to calculate the distances for " + toString(numSeqs) + " sequences."); m->mothurOutEndLine();
354 catch(exception& e) {
355 m->errorOut(e, "DistanceCommand", "execute");
359 /**************************************************************************************************/
360 void DistanceCommand::createProcesses(string filename) {
362 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
366 //loop through and create all the processes you want
367 while (process != processors) {
371 processIDS[lines[process]->end] = pid; //create map from line number to pid so you can append files in correct order later
374 driver(lines[process]->start, lines[process]->end, filename + toString(getpid()) + ".temp", cutoff);
376 }else { m->mothurOut("unable to spawn the necessary processes."); m->mothurOutEndLine(); exit(0); }
379 //force parent to wait until all the processes are done
380 for (map<int, int>::iterator it = processIDS.begin(); it != processIDS.end(); it++) {
381 int temp = it->second;
386 catch(exception& e) {
387 m->errorOut(e, "DistanceCommand", "createProcesses");
392 /**************************************************************************************************/
393 /////// need to fix to work with calcs and sequencedb
394 int DistanceCommand::driver(int startLine, int endLine, string dFileName, float cutoff){
397 int startTime = time(NULL);
400 ofstream outFile(dFileName.c_str(), ios::trunc);
401 outFile.setf(ios::fixed, ios::showpoint);
402 outFile << setprecision(4);
404 if((output == "lt") && startLine == 0){ outFile << alignDB.getNumSeqs() << endl; }
406 for(int i=startLine;i<endLine;i++){
408 string name = alignDB.get(i).getName();
409 if (name.length() < 10) { //pad with spaces to make compatible
410 while (name.length() < 10) { name += " "; }
412 outFile << name << '\t';
414 for(int j=0;j<i;j++){
416 if (m->control_pressed) { outFile.close(); return 0; }
418 distCalculator->calcDist(alignDB.get(i), alignDB.get(j));
419 double dist = distCalculator->getDist();
422 if (output == "column") { outFile << alignDB.get(i).getName() << ' ' << alignDB.get(j).getName() << ' ' << dist << endl; }
424 if (output == "lt") { outFile << dist << '\t'; }
426 if (output == "square") { //make a square column you can convert to square phylip
427 outFile << alignDB.get(i).getName() << '\t' << alignDB.get(j).getName() << '\t' << dist << endl;
428 outFile << alignDB.get(j).getName() << '\t' << alignDB.get(i).getName() << '\t' << dist << endl;
433 if (output == "lt") { outFile << endl; }
436 m->mothurOut(toString(i) + "\t" + toString(time(NULL) - startTime)); m->mothurOutEndLine();
440 m->mothurOut(toString(endLine-1) + "\t" + toString(time(NULL) - startTime)); m->mothurOutEndLine();
446 catch(exception& e) {
447 m->errorOut(e, "DistanceCommand", "driver");
452 /**************************************************************************************************/
453 /////// need to fix to work with calcs and sequencedb
454 int DistanceCommand::driverMPI(int startLine, int endLine, MPI_File& outMPI, float cutoff){
457 int startTime = time(NULL);
459 string outputString = "";
461 for(int i=startLine;i<endLine;i++){
463 for(int j=0;j<i;j++){
465 if (m->control_pressed) { return 0; }
467 distCalculator->calcDist(alignDB.get(i), alignDB.get(j));
468 double dist = distCalculator->getDist();
471 if (output == "column") { outputString += (alignDB.get(i).getName() + ' ' + alignDB.get(j).getName() + ' ' + toString(dist) + '\n'); }
474 if (output == "square") { //make a square column you can convert to square phylip
475 outputString += (alignDB.get(i).getName() + ' ' + alignDB.get(j).getName() + ' ' + toString(dist) + '\n');
476 outputString += (alignDB.get(j).getName() + ' ' + alignDB.get(i).getName() + ' ' + toString(dist) + '\n');
481 //m->mothurOut(toString(i) + "\t" + toString(time(NULL) - startTime)); m->mothurOutEndLine();
482 cout << i << '\t' << (time(NULL) - startTime) << endl;
486 //send results to parent
487 int length = outputString.length();
489 strcpy(buf, outputString.c_str());
491 MPI_File_write_shared(outMPI, buf, length, MPI_CHAR, &status);
496 //m->mothurOut(toString(endLine-1) + "\t" + toString(time(NULL) - startTime)); m->mothurOutEndLine();
497 cout << (endLine-1) << '\t' << (time(NULL) - startTime) << endl;
500 catch(exception& e) {
501 m->errorOut(e, "DistanceCommand", "driverMPI");
505 /**************************************************************************************************/
506 /////// need to fix to work with calcs and sequencedb
507 int DistanceCommand::driverMPI(int startLine, int endLine, string file, long& size){
512 int amode=MPI_MODE_CREATE|MPI_MODE_WRONLY;
514 char filename[file.length()];
515 strcpy(filename, file.c_str());
517 MPI_File_open(MPI_COMM_SELF, filename, amode, MPI_INFO_NULL, &outMPI);
519 int startTime = time(NULL);
521 string outputString = "";
524 if((output == "lt") && startLine == 0){ outputString += toString(alignDB.getNumSeqs()) + "\n"; }
526 for(int i=startLine;i<endLine;i++){
528 string name = alignDB.get(i).getName();
529 if (name.length() < 10) { //pad with spaces to make compatible
530 while (name.length() < 10) { name += " "; }
532 outputString += name + "\t";
534 for(int j=0;j<i;j++){
536 if (m->control_pressed) { return 0; }
538 distCalculator->calcDist(alignDB.get(i), alignDB.get(j));
539 double dist = distCalculator->getDist();
541 if (output == "lt") { outputString += toString(dist) + "\t"; }
544 if (output == "lt") { outputString += "\n"; }
548 //m->mothurOut(toString(i) + "\t" + toString(time(NULL) - startTime)); m->mothurOutEndLine();
549 cout << i << '\t' << (time(NULL) - startTime) << endl;
553 //send results to parent
554 int length = outputString.length();
556 strcpy(buf, outputString.c_str());
558 MPI_File_write(outMPI, buf, length, MPI_CHAR, &status);
559 size += outputString.length();
565 //m->mothurOut(toString(endLine-1) + "\t" + toString(time(NULL) - startTime)); m->mothurOutEndLine();
566 cout << (endLine-1) << '\t' << (time(NULL) - startTime) << endl;
567 MPI_File_close(&outMPI);
571 catch(exception& e) {
572 m->errorOut(e, "DistanceCommand", "driverMPI");
577 /**************************************************************************************************/
578 int DistanceCommand::convertMatrix(string outputFile) {
581 //sort file by first column so the distances for each row are together
582 string outfile = getRootName(outputFile) + "sorted.dist.temp";
585 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
586 string command = "sort -n " + outputFile + " -o " + outfile;
587 system(command.c_str());
588 #else //sort using windows sort
589 string command = "sort " + outputFile + " /O " + outfile;
590 system(command.c_str());
594 //output to new file distance for each row and save positions in file where new row begins
596 openInputFile(outfile, in);
599 openOutputFile(outputFile, out);
601 out.setf(ios::fixed, ios::floatfield); out.setf(ios::showpoint);
603 out << alignDB.getNumSeqs() << endl;
605 //get first currentRow
606 string first, currentRow, second;
608 map<string, float> rowDists; //take advantage of the fact that maps are already sorted by key
609 map<string, float>::iterator it;
614 rowDists[first] = 0.00; //distance to yourself is 0.0
617 //openInputFile(outfile, in);
620 if (m->control_pressed) { in.close(); remove(outfile.c_str()); out.close(); return 0; }
622 in >> first >> second >> dist; gobble(in);
624 if (first != currentRow) {
626 out << currentRow << '\t'; //print name
629 for (it = rowDists.begin(); it != rowDists.end(); it++) {
630 out << it->second << '\t';
637 rowDists[first] = 0.00;
638 rowDists[second] = dist;
640 rowDists[second] = dist;
644 out << currentRow << '\t'; //print name
647 for (it = rowDists.begin(); it != rowDists.end(); it++) {
648 out << it->second << '\t';
655 remove(outfile.c_str());
660 catch(exception& e) {
661 m->errorOut(e, "DistanceCommand", "convertMatrix");
665 /**************************************************************************************************/
666 int DistanceCommand::convertToLowerTriangle(string outputFile) {
669 //sort file by first column so the distances for each row are together
670 string outfile = getRootName(outputFile) + "sorted.dist.temp";
673 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux)
674 string command = "sort -n " + outputFile + " -o " + outfile;
675 system(command.c_str());
676 #else //sort using windows sort
677 string command = "sort " + outputFile + " /O " + outfile;
678 system(command.c_str());
682 //output to new file distance for each row and save positions in file where new row begins
684 openInputFile(outfile, in);
687 openOutputFile(outputFile, out);
689 out.setf(ios::fixed, ios::floatfield); out.setf(ios::showpoint);
691 out << alignDB.getNumSeqs() << endl;
693 //get first currentRow
694 string first, currentRow, second;
698 map<string, float> rowDists; //take advantage of the fact that maps are already sorted by key
699 map<string, float>::iterator it;
704 rowDists[first] = 0.00; //distance to yourself is 0.0
707 //openInputFile(outfile, in);
710 if (m->control_pressed) { in.close(); remove(outfile.c_str()); out.close(); return 0; }
712 in >> first >> second >> dist; gobble(in);
714 if (first != currentRow) {
716 out << currentRow << '\t'; //print name
719 for (it = rowDists.begin(); it != rowDists.end(); it++) {
720 if (j >= i) { break; }
721 out << it->second << '\t';
729 rowDists[first] = 0.00;
730 rowDists[second] = dist;
734 rowDists[second] = dist;
738 out << currentRow << '\t'; //print name
741 for (it = rowDists.begin(); it != rowDists.end(); it++) {
742 out << it->second << '\t';
749 remove(outfile.c_str());
754 catch(exception& e) {
755 m->errorOut(e, "DistanceCommand", "convertToLowerTriangle");
759 /**************************************************************************************************
760 void DistanceCommand::appendFiles(string temp, string filename) {
765 //open output file in append mode
766 openOutputFileAppend(filename, output);
767 openInputFile(temp, input);
769 while(char c = input.get()){
770 if(input.eof()) { break; }
771 else { output << c; }
777 catch(exception& e) {
778 m->errorOut(e, "DistanceCommand", "appendFiles");
782 /**************************************************************************************************/