]> git.donarmstrong.com Git - mothur.git/blobdiff - otuhierarchycommand.cpp
adding labels to list file.
[mothur.git] / otuhierarchycommand.cpp
index 05d6443725be6028411573b6ee280220cb52ff0c..07e3c1d0146ef521563697fe07deb38d7837b67d 100644 (file)
@@ -9,18 +9,82 @@
 
 #include "otuhierarchycommand.h"
 
+//**********************************************************************************************************************
+vector<string> OtuHierarchyCommand::setParameters(){   
+       try {
+               CommandParameter poutput("output", "Multiple", "name-number", "name", "", "", "","",false,false); parameters.push_back(poutput);
+               CommandParameter plist("list", "InputTypes", "", "", "none", "none", "none","otuheirarchy",false,true,true); parameters.push_back(plist);
+               CommandParameter plabel("label", "String", "", "", "", "", "","",false,false); parameters.push_back(plabel);
+               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, "OtuHierarchyCommand", "setParameters");
+               exit(1);
+       }
+}
+//**********************************************************************************************************************
+string OtuHierarchyCommand::getHelpString(){   
+       try {
+               string helpString = "";
+               helpString += "The otu.hierarchy command is used to see how otus relate at two distances. \n";
+               helpString += "The otu.hierarchy command parameters are list, label and output.  list and label parameters are required. \n";
+               helpString += "The output parameter allows you to output the names of the sequence in the OTUs or the OTU numbers. Options are name and number, default is name. \n";
+               helpString += "The otu.hierarchy command should be in the following format: \n";
+               helpString += "otu.hierarchy(list=yourListFile, label=yourLabels).\n";
+               helpString += "Example otu.hierarchy(list=amazon.fn.list, label=0.01-0.03).\n";
+               helpString += "The otu.hierarchy command outputs a .otu.hierarchy file which is described on the wiki.\n";
+               helpString += "Note: No spaces between parameter labels (i.e. list), '=' and parameters (i.e.yourListFile).\n";
+               return helpString;
+       }
+       catch(exception& e) {
+               m->errorOut(e, "OtuHierarchyCommand", "getHelpString");
+               exit(1);
+       }
+}
+//**********************************************************************************************************************
+string OtuHierarchyCommand::getOutputPattern(string type) {
+    try {
+        string pattern = "";
+        
+        if (type == "otuheirarchy") {  pattern = "[filename],[distance1],[tag],[distance2],otu.hierarchy"; } 
+        else { m->mothurOut("[ERROR]: No definition for type " + type + " output pattern.\n"); m->control_pressed = true;  }
+        
+        return pattern;
+    }
+    catch(exception& e) {
+        m->errorOut(e, "OtuHierarchyCommand", "getOutputPattern");
+        exit(1);
+    }
+}
+//**********************************************************************************************************************
+OtuHierarchyCommand::OtuHierarchyCommand(){    
+       try {
+               abort = true; calledHelp = true; 
+               setParameters();
+               vector<string> tempOutNames;
+               outputTypes["otuheirarchy"] = tempOutNames;
+       }
+       catch(exception& e) {
+               m->errorOut(e, "OtuHierarchyCommand", "OtuHierarchyCommand");
+               exit(1);
+       }
+}
 //**********************************************************************************************************************
 OtuHierarchyCommand::OtuHierarchyCommand(string option) {
        try {
-               abort = false;
+               abort = false; calledHelp = false;   
                
                //allow user to run help
-               if(option == "help") {  help(); abort = true; }
+               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[] =  {"list","label","output","outputdir","inputdir"};
-                       vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+                       vector<string> myArray = setParameters();
                        
                        OptionParser parser(option);
                        map<string,string> parameters = parser.getParameters();
@@ -33,6 +97,10 @@ OtuHierarchyCommand::OtuHierarchyCommand(string option) {
                                if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
                        }
                        
+                       //initialize outputTypes
+                       vector<string> tempOutNames;
+                       outputTypes["otuheirarchy"] = tempOutNames;
+                       
                        //if the user changes the input directory command factory will send this info to us in the output parameter 
                        string inputDir = validParameter.validFile(parameters, "inputdir", false);              
                        if (inputDir == "not found"){   inputDir = "";          }
@@ -41,20 +109,27 @@ OtuHierarchyCommand::OtuHierarchyCommand(string option) {
                                it = parameters.find("list");
                                //user has given a template file
                                if(it != parameters.end()){ 
-                                       path = hasPath(it->second);
+                                       path = m->hasPath(it->second);
                                        //if the user has not given a path then, add inputdir. else leave path alone.
                                        if (path == "") {       parameters["list"] = inputDir + it->second;             }
                                }
                        }
 
                        listFile = validParameter.validFile(parameters, "list", true);
-                       if (listFile == "not found") { m->mothurOut("list is a required parameter for the otu.hierarchy command."); m->mothurOutEndLine(); abort = true; }
-                       else if (listFile == "not open") { abort = true; }      
+                       if (listFile == "not found") { 
+                               listFile = m->getListFile(); 
+                               if (listFile != "") {  m->mothurOut("Using " + listFile + " as input file for the list parameter."); m->mothurOutEndLine(); }
+                               else { 
+                                       m->mothurOut("No valid current list file. You must provide a list file."); m->mothurOutEndLine(); 
+                                       abort = true;
+                               }
+                       }else if (listFile == "not open") { abort = true; }     
+                       else { m->setListFile(listFile); }
                        
                        //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"){  
                                outputDir = ""; 
-                               outputDir += hasPath(listFile); //if user entered a file with a path then preserve it   
+                               outputDir += m->hasPath(listFile); //if user entered a file with a path then preserve it        
                        }
                        
                        //check for optional parameter and set defaults
@@ -62,7 +137,7 @@ OtuHierarchyCommand::OtuHierarchyCommand(string option) {
                        label = validParameter.validFile(parameters, "label", false);                   
                        if (label == "not found") { m->mothurOut("label is a required parameter for the otu.hierarchy command."); m->mothurOutEndLine(); abort = true; }
                        else { 
-                               splitAtDash(label, labels);
+                               m->splitAtDash(label, labels);
                                if (labels.size() != 2) { m->mothurOut("You must provide 2 labels."); m->mothurOutEndLine(); abort = true; }
                        }       
                        
@@ -79,38 +154,15 @@ OtuHierarchyCommand::OtuHierarchyCommand(string option) {
 }
 //**********************************************************************************************************************
 
-void OtuHierarchyCommand::help(){
-       try {
-               m->mothurOut("The otu.hierarchy command is used to see how otus relate at two distances. \n");
-               m->mothurOut("The otu.hierarchy command parameters are list, label and output.  list and label parameters are required. \n");
-               m->mothurOut("The output parameter allows you to output the names of the sequence in the OTUs or the OTU numbers. Options are name and number, default is name. \n");
-               m->mothurOut("The otu.hierarchy command should be in the following format: \n");
-               m->mothurOut("otu.hierarchy(list=yourListFile, label=yourLabels).\n");
-               m->mothurOut("Example otu.hierarchy(list=amazon.fn.list, label=0.01-0.03).\n");
-               m->mothurOut("The otu.hierarchy command outputs a .otu.hierarchy file which is described on the wiki.\n");
-               m->mothurOut("Note: No spaces between parameter labels (i.e. list), '=' and parameters (i.e.yourListFile).\n\n");
-       }
-       catch(exception& e) {
-               m->errorOut(e, "OtuHierarchyCommand", "help");
-               exit(1);
-       }
-}
-
-//**********************************************************************************************************************
-
-OtuHierarchyCommand::~OtuHierarchyCommand(){}
-
-//**********************************************************************************************************************
-
 int OtuHierarchyCommand::execute(){
        try {
                
-               if (abort == true) { return 0; }
+               if (abort == true) { if (calledHelp) { return 0; }  return 2;   }
                
                //get listvectors that correspond to labels requested, (or use smart distancing to get closest listvector)
                vector<ListVector> lists = getListVectors();
                
-               if (m->control_pressed) { return 0; }
+               if (m->control_pressed) { outputTypes.clear(); return 0; }
                
                //determine which is little and which is big, putting little first
                if (lists.size() == 2) {
@@ -123,56 +175,48 @@ int OtuHierarchyCommand::execute(){
                }
                
                //map sequences to bin number in the "little" otu
-               map<string, int> littleBins; 
+               map<string, int> littleBins;
+        vector<string> binLabels0 = lists[0].getLabels();
                for (int i = 0; i < lists[0].getNumBins(); i++) {
                
                        if (m->control_pressed) {  return 0; }
-                       
-                       string names = lists[0].get(i); 
-                       
-                       //parse bin
-                       while (names.find_first_of(',') != -1) { 
-                               string name = names.substr(0,names.find_first_of(','));
-                               names = names.substr(names.find_first_of(',')+1, names.length());
-                               littleBins[name] = i;  
-                       }
-                       
-                       //get last name
-                       littleBins[names] = i;
-               }
+                       string bin = lists[0].get(i);
+            vector<string> names; m->splitAtComma(bin, names);
+                       for (int j = 0; j < names.size(); j++) { littleBins[names[j]] = i; }
+        }
                
                ofstream out;
-               string outputFileName = outputDir + getRootName(getSimpleName(listFile)) + lists[0].getLabel() + "-" + lists[1].getLabel() + ".otu.hierarchy";
-               openOutputFile(outputFileName, out);
+        map<string, string> variables; 
+        variables["[filename]"] = outputDir + m->getRootName(m->getSimpleName(listFile));
+        variables["[distance1]"] = lists[0].getLabel();
+        variables["[tag]"] = "-"; 
+        variables["[distance2]"] = lists[1].getLabel();
+               string outputFileName = getOutputFileName("otuheirarchy",variables);
+               m->openOutputFile(outputFileName, out);
                
                //go through each bin in "big" otu and output the bins in "little" otu which created it
+        vector<string> binLabels1 = lists[1].getLabels();
                for (int i = 0; i < lists[1].getNumBins(); i++) {
                
-                       if (m->control_pressed) { out.close(); remove(outputFileName.c_str()); return 0; }
+                       if (m->control_pressed) { outputTypes.clear(); out.close(); m->mothurRemove(outputFileName); return 0; }
                        
-                       string names = lists[1].get(i);
+                       string binnames = lists[1].get(i);
+            vector<string> names; m->splitAtComma(binnames, names);
                        
                        //output column 1
-                       if (output == "name")   {   out << names << '\t';       }
-                       else                                    {       out << i << '\t';               }
+                       if (output == "name")   {   out << binnames << '\t';    }
+                       else                                    {       out << binLabels1[i] << '\t';           }
                        
                        map<int, int> bins; //bin numbers in little that are in this bin in big
                        map<int, int>::iterator it;
                        
                        //parse bin
-                       while (names.find_first_of(',') != -1) { 
-                               string name = names.substr(0,names.find_first_of(','));
-                               names = names.substr(names.find_first_of(',')+1, names.length());
-                               bins[littleBins[name]] = littleBins[name];  
-                       }
-                       
-                       //get last name
-                       bins[littleBins[names]] = littleBins[names]; 
+                       for (int j = 0; j < names.size(); j++) { bins[littleBins[names[j]]] = littleBins[names[j]];   }
                        
                        string col2 = "";
                        for (it = bins.begin(); it != bins.end(); it++) {
                                if (output == "name")   {   col2 += lists[0].get(it->first) + "\t";     }
-                               else                                    {       col2 += toString(it->first) + "\t";             }
+                               else                                    {       col2 += binLabels0[it->first] + "\t";           }
                        }
                        
                        //output column 2
@@ -181,11 +225,11 @@ int OtuHierarchyCommand::execute(){
                
                out.close();
                
-               if (m->control_pressed) { remove(outputFileName.c_str()); return 0; }
+               if (m->control_pressed) { outputTypes.clear(); m->mothurRemove(outputFileName); return 0; }
                
                m->mothurOutEndLine();
-               m->mothurOut("Output File Name: "); m->mothurOutEndLine();
-               m->mothurOut(outputFileName); m->mothurOutEndLine();    
+               m->mothurOut("Output File Names: "); m->mothurOutEndLine();
+               m->mothurOut(outputFileName); m->mothurOutEndLine();    outputNames.push_back(outputFileName); outputTypes["otuheirarchy"].push_back(outputFileName); 
                m->mothurOutEndLine();
                
                return 0;
@@ -211,7 +255,7 @@ vector<ListVector> OtuHierarchyCommand::getListVectors() {
 
                //open file
                ifstream in;
-               openInputFile(listFile, in);
+               m->openInputFile(listFile, in);
                
                //get first list vector in file
                ListVector* list = NULL;
@@ -220,7 +264,7 @@ vector<ListVector> OtuHierarchyCommand::getListVectors() {
                        pos = in.tellg();
                        lastPos = pos;
                        list = new ListVector(in);  
-                       gobble(in);
+                       m->gobble(in);
                        lastLabel = list->getLabel();
                }
                
@@ -240,7 +284,7 @@ vector<ListVector> OtuHierarchyCommand::getListVectors() {
                        }
                
                        //you have a label the user want that is smaller than this label and the last label has not already been processed 
-                       if ((anyLabelsToProcess(list->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+                       if ((m->anyLabelsToProcess(list->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
                                string saveLabel = list->getLabel();
                                int savePos = in.tellg();
                                
@@ -271,7 +315,7 @@ vector<ListVector> OtuHierarchyCommand::getListVectors() {
                        if (!in.eof())  {       
                                pos = in.tellg();
                                list = new ListVector(in);  
-                               gobble(in);
+                               m->gobble(in);
                        }else { list = NULL; }
                }