]> git.donarmstrong.com Git - mothur.git/blobdiff - distancecommand.cpp
rewrote metastats command in c++, added mothurRemove function to handle ~ error....
[mothur.git] / distancecommand.cpp
index 5ffe0da63cfbbafd80ab1813a66b3cdb9779725b..b69b93d85c44c1fa89d08d49c0fb478b2f0cb242 100644 (file)
 #include "onegapdist.h"
 #include "onegapignore.h"
 
-
 //**********************************************************************************************************************
-vector<string> DistanceCommand::getValidParameters(){  
+vector<string> DistanceCommand::setParameters(){       
        try {
-               string Array[] =  {"fasta","oldfasta","column", "output", "calc", "countends", "cutoff", "processors", "outputdir","inputdir","compress"};
-               vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+               CommandParameter pcolumn("column", "InputTypes", "", "", "none", "none", "OldFastaColumn",false,false); parameters.push_back(pcolumn);
+               CommandParameter poldfasta("oldfasta", "InputTypes", "", "", "none", "none", "OldFastaColumn",false,false); parameters.push_back(poldfasta);
+               CommandParameter pfasta("fasta", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(pfasta);
+               CommandParameter poutput("output", "Multiple", "column-lt-square", "column", "", "", "",false,false); parameters.push_back(poutput);
+               CommandParameter pcalc("calc", "Multiple", "nogaps-eachgap-onegap", "onegap", "", "", "",false,false); parameters.push_back(pcalc);
+               CommandParameter pcountends("countends", "Boolean", "", "T", "", "", "",false,false); parameters.push_back(pcountends);
+               CommandParameter pcompress("compress", "Boolean", "", "F", "", "", "",false,false); parameters.push_back(pcompress);
+               CommandParameter pprocessors("processors", "Number", "", "1", "", "", "",false,false); parameters.push_back(pprocessors);
+               CommandParameter pcutoff("cutoff", "Number", "", "1.0", "", "", "",false,false); parameters.push_back(pcutoff);
+               CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir);
+               CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir);
+               
+               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, "DistanceCommand", "getValidParameters");
-               exit(1);
-       }
-}
-//**********************************************************************************************************************
-DistanceCommand::DistanceCommand(){    
-       try {
-               abort = true; calledHelp = true; 
-               vector<string> tempOutNames;
-               outputTypes["phylip"] = tempOutNames;
-               outputTypes["column"] = tempOutNames;
-       }
-       catch(exception& e) {
-               m->errorOut(e, "DistanceCommand", "DistanceCommand");
+               m->errorOut(e, "DistanceCommand", "setParameters");
                exit(1);
        }
 }
 //**********************************************************************************************************************
-vector<string> DistanceCommand::getRequiredParameters(){       
+string DistanceCommand::getHelpString(){       
        try {
-               string Array[] =  {"fasta"};
-               vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
-               return myArray;
+               string helpString = "";
+               helpString += "The dist.seqs command reads a file containing sequences and creates a distance file.\n";
+               helpString += "The dist.seqs command parameters are fasta, oldfasta, column, calc, countends, output, compress, cutoff and processors.  \n";
+               helpString += "The fasta parameter is required, unless you have a valid current fasta file.\n";
+               helpString += "The oldfasta and column parameters allow you to append the distances calculated to the column file.\n";
+               helpString += "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";
+               helpString += "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";
+               helpString += "The cutoff parameter allows you to specify maximum distance to keep. The default is 1.0.\n";
+               helpString += "The output parameter allows you to specify format of your distance matrix. Options are column, lt, and square. The default is column.\n";
+               helpString += "The processors parameter allows you to specify number of processors to use.  The default is 1.\n";
+               helpString += "The compress parameter allows you to indicate that you want the resulting distance file compressed.  The default is false.\n";
+               helpString += "The dist.seqs command should be in the following format: \n";
+               helpString += "dist.seqs(fasta=yourFastaFile, calc=yourCalc, countends=yourEnds, cutoff= yourCutOff, processors=yourProcessors) \n";
+               helpString += "Example dist.seqs(fasta=amazon.fasta, calc=eachgap, countends=F, cutoff= 2.0, processors=3).\n";
+               helpString += "Note: No spaces between parameter labels (i.e. calc), '=' and parameters (i.e.yourCalc).\n";
+               return helpString;
        }
        catch(exception& e) {
-               m->errorOut(e, "DistanceCommand", "getRequiredParameters");
+               m->errorOut(e, "DistanceCommand", "getHelpString");
                exit(1);
        }
 }
 //**********************************************************************************************************************
-vector<string> DistanceCommand::getRequiredFiles(){    
+DistanceCommand::DistanceCommand(){    
        try {
-               vector<string> myArray;
-               return myArray;
+               abort = true; calledHelp = true; 
+               setParameters();
+               vector<string> tempOutNames;
+               outputTypes["phylip"] = tempOutNames;
+               outputTypes["column"] = tempOutNames;
        }
        catch(exception& e) {
-               m->errorOut(e, "DistanceCommand", "getRequiredFiles");
+               m->errorOut(e, "DistanceCommand", "DistanceCommand");
                exit(1);
        }
 }
@@ -71,12 +85,10 @@ DistanceCommand::DistanceCommand(string option) {
                                
                //allow user to run help
                if(option == "help") { help(); abort = true; calledHelp = true; }
+               else if(option == "citation") { citation(); abort = true; calledHelp = true;}
                
                else {
-                       //valid paramters for this command
-                       string Array[] =  {"fasta","oldfasta","column", "output", "calc", "countends", "cutoff", "processors", "outputdir","inputdir","compress"};
-
-                       vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+                       vector<string> myArray = setParameters();
                        
                        OptionParser parser(option);
                        map<string, string> parameters = parser.getParameters();
@@ -126,13 +138,21 @@ DistanceCommand::DistanceCommand(string option) {
 
                        //check for required parameters
                        fastafile = validParameter.validFile(parameters, "fasta", true);
-                       if (fastafile == "not found") { m->mothurOut("fasta is a required parameter for the dist.seqs command."); m->mothurOutEndLine(); abort = true; }
-                       else if (fastafile == "not open") { abort = true; }     
+                       if (fastafile == "not found") {                                 
+                               fastafile = m->getFastaFile(); 
+                               if (fastafile != "") { m->mothurOut("Using " + fastafile + " as input file for the fasta parameter."); m->mothurOutEndLine(); 
+                                       ifstream inFASTA;
+                                       m->openInputFile(fastafile, inFASTA);
+                                       alignDB = SequenceDB(inFASTA); 
+                                       inFASTA.close();
+                               }else {         m->mothurOut("You have no current fastafile and the fasta parameter is required."); m->mothurOutEndLine(); abort = true; }
+                       }else if (fastafile == "not open") { abort = true; }    
                        else{
                                ifstream inFASTA;
                                m->openInputFile(fastafile, inFASTA);
                                alignDB = SequenceDB(inFASTA); 
                                inFASTA.close();
+                               m->setFastaFile(fastafile);
                        }
                        
                        oldfastafile = validParameter.validFile(parameters, "oldfasta", true);
@@ -142,6 +162,7 @@ DistanceCommand::DistanceCommand(string option) {
                        column = validParameter.validFile(parameters, "column", true);
                        if (column == "not found") { column = ""; }
                        else if (column == "not open") { abort = true; }        
+                       else { m->setColumnFile(column); }
                        
                        //if the user changes the output directory command factory will send this info to us in the output parameter 
                        outputDir = validParameter.validFile(parameters, "outputdir", false);           if (outputDir == "not found"){  
@@ -165,8 +186,9 @@ DistanceCommand::DistanceCommand(string option) {
                        temp = validParameter.validFile(parameters, "cutoff", false);           if(temp == "not found"){        temp = "1.0"; }
                        convert(temp, cutoff); 
                        
-                       temp = validParameter.validFile(parameters, "processors", false);       if(temp == "not found"){        temp = "1"; }
-                       convert(temp, processors); 
+                       temp = validParameter.validFile(parameters, "processors", false);       if (temp == "not found"){       temp = m->getProcessors();      }
+                       m->setProcessors(temp);
+                       convert(temp, processors);
                        
                        temp = validParameter.validFile(parameters, "compress", false);         if(temp == "not found"){  temp = "F"; }
                        convert(temp, compress);
@@ -207,35 +229,6 @@ DistanceCommand::DistanceCommand(string option) {
                exit(1);
        }
 }
-
-//**********************************************************************************************************************
-
-DistanceCommand::~DistanceCommand(){}
-       
-//**********************************************************************************************************************
-
-void DistanceCommand::help(){
-       try {
-               m->mothurOut("The dist.seqs command reads a file containing sequences and creates a distance file.\n");
-               m->mothurOut("The dist.seqs command parameters are fasta, oldfasta, column, calc, countends, output, compress, cutoff and processors.  \n");
-               m->mothurOut("The fasta parameter is required.\n");
-               m->mothurOut("The oldfasta and column parameters allow you to append the distances calculated to the column file.\n");
-               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");
-               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");
-               m->mothurOut("The cutoff parameter allows you to specify maximum distance to keep. The default is 1.0.\n");
-               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");
-               m->mothurOut("The processors parameter allows you to specify number of processors to use.  The default is 1.\n");
-               m->mothurOut("The compress parameter allows you to indicate that you want the resulting distance file compressed.  The default is false.\n");
-               m->mothurOut("The dist.seqs command should be in the following format: \n");
-               m->mothurOut("dist.seqs(fasta=yourFastaFile, calc=yourCalc, countends=yourEnds, cutoff= yourCutOff, processors=yourProcessors) \n");
-               m->mothurOut("Example dist.seqs(fasta=amazon.fasta, calc=eachgap, countends=F, cutoff= 2.0, processors=3).\n");
-               m->mothurOut("Note: No spaces between parameter labels (i.e. calc), '=' and parameters (i.e.yourCalc).\n\n");
-       }
-       catch(exception& e) {
-               m->errorOut(e, "DistanceCommand", "help");
-               exit(1);
-       }
-}
 //**********************************************************************************************************************
 
 int DistanceCommand::execute(){
@@ -256,11 +249,13 @@ int DistanceCommand::execute(){
                int numSeqs = alignDB.getNumSeqs();
                cutoff += 0.005;
                
+               if (!alignDB.sameLength()) {  m->mothurOut("[ERROR]: your sequences are not the same length, aborting."); m->mothurOutEndLine(); return 0; }
+               
                string outputFile;
                                
                if (output == "lt") { //does the user want lower triangle phylip formatted file 
                        outputFile = outputDir + m->getRootName(m->getSimpleName(fastafile)) + "phylip.dist";
-                       remove(outputFile.c_str()); outputTypes["phylip"].push_back(outputFile);
+                       m->mothurRemove(outputFile); outputTypes["phylip"].push_back(outputFile);
                        
                        //output numSeqs to phylip formatted dist file
                }else if (output == "column") { //user wants column format
@@ -273,10 +268,10 @@ int DistanceCommand::execute(){
                                rename(column.c_str(), tempcolumn.c_str());
                        }
                        
-                       remove(outputFile.c_str());
+                       m->mothurRemove(outputFile);
                }else { //assume square
                        outputFile = outputDir + m->getRootName(m->getSimpleName(fastafile)) + "square.dist";
-                       remove(outputFile.c_str());
+                       m->mothurRemove(outputFile);
                        outputTypes["phylip"].push_back(outputFile);
                }
                
@@ -454,7 +449,7 @@ int DistanceCommand::execute(){
        #endif
        
 #endif
-               if (m->control_pressed) { outputTypes.clear();  delete distCalculator; remove(outputFile.c_str()); return 0; }
+               if (m->control_pressed) { outputTypes.clear();  delete distCalculator; m->mothurRemove(outputFile); return 0; }
                
                #ifdef USE_MPI
                        MPI_Comm_rank(MPI_COMM_WORLD, &pid); 
@@ -477,17 +472,17 @@ int DistanceCommand::execute(){
                        if (outputFile == column) { 
                                string tempcolumn = column + ".old";
                                m->appendFiles(tempcolumn, outputFile);
-                               remove(tempcolumn.c_str());
+                               m->mothurRemove(tempcolumn);
                        }else{
                                m->appendFiles(outputFile, column);
-                               remove(outputFile.c_str());
+                               m->mothurRemove(outputFile);
                                outputFile = column;
                        }
                        
                        if (outputDir != "") { 
                                string newOutputName = outputDir + m->getSimpleName(outputFile);
                                rename(outputFile.c_str(), newOutputName.c_str());
-                               remove(outputFile.c_str());
+                               m->mothurRemove(outputFile);
                                outputFile = newOutputName;
                        }
                }
@@ -497,7 +492,7 @@ int DistanceCommand::execute(){
                        }
                #endif
                
-               if (m->control_pressed) { outputTypes.clear();  delete distCalculator; remove(outputFile.c_str()); return 0; }
+               if (m->control_pressed) { outputTypes.clear();  delete distCalculator; m->mothurRemove(outputFile); return 0; }
                
                delete distCalculator;
                
@@ -576,7 +571,7 @@ void DistanceCommand::createProcesses(string filename) {
                //append and remove temp files
                for (int i=0;i<processIDS.size();i++) { 
                        m->appendFiles((filename + toString(processIDS[i]) + ".temp"), filename);
-                       remove((filename + toString(processIDS[i]) + ".temp").c_str());
+                       m->mothurRemove((filename + toString(processIDS[i]) + ".temp"));
                }
 #endif
        }
@@ -940,7 +935,7 @@ int DistanceCommand::convertMatrix(string outputFile) {
                //m->openInputFile(outfile, in);
                
                while(!in.eof()) {
-                       if (m->control_pressed) { in.close(); remove(outfile.c_str()); out.close(); return 0; }
+                       if (m->control_pressed) { in.close(); m->mothurRemove(outfile); out.close(); return 0; }
                        
                        in >> first >> second >> dist; m->gobble(in);
                                
@@ -975,7 +970,7 @@ int DistanceCommand::convertMatrix(string outputFile) {
                in.close();
                out.close();
                
-               remove(outfile.c_str());
+               m->mothurRemove(outfile);
                
                return 1;
                
@@ -1030,7 +1025,7 @@ int DistanceCommand::convertToLowerTriangle(string outputFile) {
                //m->openInputFile(outfile, in);
                
                while(!in.eof()) {
-                       if (m->control_pressed) { in.close(); remove(outfile.c_str()); out.close(); return 0; }
+                       if (m->control_pressed) { in.close(); m->mothurRemove(outfile); out.close(); return 0; }
                        
                        in >> first >> second >> dist; m->gobble(in);
                                
@@ -1069,7 +1064,7 @@ int DistanceCommand::convertToLowerTriangle(string outputFile) {
                in.close();
                out.close();
                
-               remove(outfile.c_str());
+               m->mothurRemove(outfile);
                
                return 1;
                
@@ -1140,7 +1135,7 @@ bool DistanceCommand::sanityCheck() {
                string name1, name2;
                float dist;
                while (!inDist.eof()) {
-                       if (m->control_pressed) {  inDist.close(); outDist.close(); remove(outputFile.c_str()); return good;  }
+                       if (m->control_pressed) {  inDist.close(); outDist.close(); m->mothurRemove(outputFile); return good;  }
                
                        inDist >> name1 >> name2 >> dist; m->gobble(inDist);
                        
@@ -1157,10 +1152,10 @@ bool DistanceCommand::sanityCheck() {
                outDist.close();
                
                if (good) {
-                       remove(column.c_str());
+                       m->mothurRemove(column);
                        rename(outputFile.c_str(), column.c_str());
                }else{
-                       remove(outputFile.c_str()); //temp file is bad because file mismatch above
+                       m->mothurRemove(outputFile); //temp file is bad because file mismatch above
                }
                
                return good;