]> git.donarmstrong.com Git - mothur.git/blobdiff - heatmapsimcommand.cpp
fixed some issues while testing 1.6
[mothur.git] / heatmapsimcommand.cpp
index dc3db89a366269c53d92632275963c9b6f1e88bc..004a3bf05a901262ca1233e16ceb862d9b5f9ebd 100644 (file)
 
 //**********************************************************************************************************************
 
-HeatMapSimCommand::HeatMapSimCommand(){
+HeatMapSimCommand::HeatMapSimCommand(string option){
        try {
                globaldata = GlobalData::getInstance();
-               validCalculator = new ValidCalculators();
-               heatmap = new HeatMapSim();
+               abort = false;
+               allLines = 1;
+               lines.clear();
+               labels.clear();
+               Groups.clear();
+               Estimators.clear();
+               
+               //allow user to run help
+               if(option == "help") { validCalculator = new ValidCalculators(); help(); abort = true; }
+               
+               else {
+                       //valid paramters for this command
+                       string AlignArray[] =  {"groups","line","label", "calc"};
+                       vector<string> myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string)));
+                       
+                       OptionParser parser(option);
+                       map<string,string> parameters = parser.getParameters();
+                       
+                       ValidParameters validParameter;
+                       
+                       //check to make sure all parameters are valid for command
+                       for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) { 
+                               if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
+                       }
                        
-               int i;
-               for (i=0; i<globaldata->Estimators.size(); i++) {
-                       if (validCalculator->isValidCalculator("heat", globaldata->Estimators[i]) == true) { 
-                               if (globaldata->Estimators[i] == "jabund") {    
-                                       heatCalculators.push_back(new JAbund());
-                               }else if (globaldata->Estimators[i] == "sorabund") { 
-                                       heatCalculators.push_back(new SorAbund());
-                               }else if (globaldata->Estimators[i] == "jclass") { 
-                                       heatCalculators.push_back(new Jclass());
-                               }else if (globaldata->Estimators[i] == "sorclass") { 
-                                       heatCalculators.push_back(new SorClass());
-                               }else if (globaldata->Estimators[i] == "jest") { 
-                                       heatCalculators.push_back(new Jest());
-                               }else if (globaldata->Estimators[i] == "sorest") { 
-                                       heatCalculators.push_back(new SorEst());
-                               }else if (globaldata->Estimators[i] == "thetayc") { 
-                                       heatCalculators.push_back(new ThetaYC());
-                               }else if (globaldata->Estimators[i] == "thetan") { 
-                                       heatCalculators.push_back(new ThetaN());
-                               }else if (globaldata->Estimators[i] == "morisitahorn") { 
-                                       heatCalculators.push_back(new MorHorn());
-                               }else if (globaldata->Estimators[i] == "braycurtis") { 
-                                       heatCalculators.push_back(new BrayCurtis());
+                       //make sure the user has already run the read.otu command
+                       if (globaldata->getSharedFile() == "") {
+                                mothurOut("You must read a list and a group, or a shared before you can use the heatmap.sim command."); mothurOutEndLine(); abort = true; 
+                       }
+
+                       //check for optional parameter and set defaults
+                       // ...at some point should added some additional type checking...
+                       line = validParameter.validFile(parameters, "line", false);                             
+                       if (line == "not found") { line = "";  }
+                       else { 
+                               if(line != "all") {  splitAtDash(line, lines);  allLines = 0;  }
+                               else { allLines = 1;  }
+                       }
+                       
+                       label = validParameter.validFile(parameters, "label", false);                   
+                       if (label == "not found") { label = ""; }
+                       else { 
+                               if(label != "all") {  splitAtDash(label, labels);  allLines = 0;  }
+                               else { allLines = 1;  }
+                       }
+                       
+                       //make sure user did not use both the line and label parameters
+                       if ((line != "") && (label != "")) { mothurOut("You cannot use both the line and label parameters at the same time. "); mothurOutEndLine(); abort = true; }
+                       //if the user has not specified any line or labels use the ones from read.otu
+                       else if ((line == "") && (label == "")) {  
+                               allLines = globaldata->allLines; 
+                               labels = globaldata->labels; 
+                               lines = globaldata->lines;
+                       }
+                       
+                       calc = validParameter.validFile(parameters, "calc", false);                     
+                       if (calc == "not found") { calc = "jest-thetayc";  }
+                       else { 
+                                if (calc == "default")  {  calc = "jest-thetayc";  }
+                       }
+                       splitAtDash(calc, Estimators);
+                       
+                       groups = validParameter.validFile(parameters, "groups", false);                 
+                       if (groups == "not found") { groups = ""; }
+                       else { 
+                               splitAtDash(groups, Groups);
+                               globaldata->Groups = Groups;
+                       }
+                       
+                       if (abort == false) {
+                               validCalculator = new ValidCalculators();
+                               heatmap = new HeatMapSim();
+                       
+                               int i;
+                               for (i=0; i<Estimators.size(); i++) {
+                                       if (validCalculator->isValidCalculator("heat", Estimators[i]) == true) { 
+                                               if (Estimators[i] == "jabund") {        
+                                                       heatCalculators.push_back(new JAbund());
+                                               }else if (Estimators[i] == "sorabund") { 
+                                                       heatCalculators.push_back(new SorAbund());
+                                               }else if (Estimators[i] == "jclass") { 
+                                                       heatCalculators.push_back(new Jclass());
+                                               }else if (Estimators[i] == "sorclass") { 
+                                                       heatCalculators.push_back(new SorClass());
+                                               }else if (Estimators[i] == "jest") { 
+                                                       heatCalculators.push_back(new Jest());
+                                               }else if (Estimators[i] == "sorest") { 
+                                                       heatCalculators.push_back(new SorEst());
+                                               }else if (Estimators[i] == "thetayc") { 
+                                                       heatCalculators.push_back(new ThetaYC());
+                                               }else if (Estimators[i] == "thetan") { 
+                                                       heatCalculators.push_back(new ThetaN());
+                                               }else if (Estimators[i] == "morisitahorn") { 
+                                                       heatCalculators.push_back(new MorHorn());
+                                               }else if (Estimators[i] == "braycurtis") { 
+                                                       heatCalculators.push_back(new BrayCurtis());
+                                               }
+                                       }
                                }
+                               
                        }
                }
-               
-               //reset calc for next command
-               globaldata->setCalc("");
 
+                               
 
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the HeatMapSimCommand class Function HeatMapSimCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               errorOut(e, "HeatMapSimCommand", "HeatMapSimCommand");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the HeatMapSimCommand class function HeatMapSimCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+}
+
+//**********************************************************************************************************************
+
+void HeatMapSimCommand::help(){
+       try {
+               mothurOut("The heatmap.sim command can only be executed after a successful read.otu command.\n");
+               mothurOut("The heatmap.sim command parameters are groups, calc, line and label.  No parameters are required, but you may not use line and label at the same time.\n");
+               mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like included in your heatmap.\n");
+               mothurOut("The group names are separated by dashes. The line and label allow you to select what distance levels you would like a heatmap created for, and are also separated by dashes.\n");
+               mothurOut("The heatmap.sim command should be in the following format: heatmap.sim(groups=yourGroups, calc=yourCalc, line=yourLines, label=yourLabels).\n");
+               mothurOut("Example heatmap.sim(groups=A-B-C, line=1-3-5, calc=jabund).\n");
+               mothurOut("The default value for groups is all the groups in your groupfile, and all lines in your inputfile will be used.\n");
+               validCalculator->printCalc("heat", cout);
+               mothurOut("The default value for calc is jclass-thetayc.\n");
+               mothurOut("The heatmap.sim command outputs a .svg file for each calculator you choose at each line or label you specify.\n");
+               mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n");
+
+       }
+       catch(exception& e) {
+               errorOut(e, "HeatMapSimCommand", "help");
                exit(1);
-       }       
+       }
 }
+
 //**********************************************************************************************************************
 
 HeatMapSimCommand::~HeatMapSimCommand(){
-       delete input;
-       delete read;
-       delete heatmap;
+       if (abort == false) {
+               delete input;  globaldata->ginput = NULL;
+               delete read;
+               delete heatmap;
+               delete validCalculator;
+       }
 }
 
 //**********************************************************************************************************************
 
 int HeatMapSimCommand::execute(){
        try {
+       
+               if (abort == true)  { return 0; }
+               
                int count = 1;  
                
                //if the users entered no valid calculators don't execute command
-               if (heatCalculators.size() == 0) { cout << "No valid calculators." << endl; return 0; }
+               if (heatCalculators.size() == 0) { mothurOut("No valid calculators."); mothurOutEndLine(); return 0; }
                
                //you have groups
                read = new ReadOTUFile(globaldata->inputFileName);      
@@ -92,22 +189,22 @@ int HeatMapSimCommand::execute(){
                        
                input = globaldata->ginput;
                lookup = input->getSharedRAbundVectors();
-               vector<SharedRAbundVector*> lastLookup = lookup;
+               string lastLabel = lookup[0]->getLabel();
                
-               if (lookup.size() < 2) { cout << "You have not provided enough valid groups.  I cannot run the command." << endl; return 0;}
+               if (lookup.size() < 2) { mothurOut("You have not provided enough valid groups.  I cannot run the command."); mothurOutEndLine(); return 0;}
                                
                //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
                set<string> processedLabels;
-               set<string> userLabels = globaldata->labels;
-               set<int> userLines = globaldata->lines;
+               set<string> userLabels = labels;
+               set<int> userLines = lines;
 
                
                //as long as you are not at the end of the file or done wih the lines you want
-               while((lookup[0] != NULL) && ((globaldata->allLines == 1) || (userLabels.size() != 0) || (userLines.size() != 0))) {
+               while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0) || (userLines.size() != 0))) {
                
-                       if(globaldata->allLines == 1 || globaldata->lines.count(count) == 1 || globaldata->labels.count(lookup[0]->getLabel()) == 1){                   
+                       if(allLines == 1 || lines.count(count) == 1 || labels.count(lookup[0]->getLabel()) == 1){                       
        
-                               cout << lookup[0]->getLabel() << '\t' << count << endl;
+                               mothurOut(lookup[0]->getLabel()); mothurOutEndLine();
                                heatmap->getPic(lookup, heatCalculators);
                                        
                                processedLabels.insert(lookup[0]->getLabel());
@@ -115,19 +212,24 @@ int HeatMapSimCommand::execute(){
                                userLines.erase(count);
                        }
                                
-                       if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLookup[0]->getLabel()) != 1)) {
-                               cout << lastLookup[0]->getLabel() << '\t' << count << endl;
-                               heatmap->getPic(lastLookup, heatCalculators);
+                       if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+                       
+                               for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  } 
+                               lookup = input->getSharedRAbundVectors(lastLabel);                              
+
+                               mothurOut(lookup[0]->getLabel()); mothurOutEndLine();
+                               heatmap->getPic(lookup, heatCalculators);
                                        
-                               processedLabels.insert(lastLookup[0]->getLabel());
-                               userLabels.erase(lastLookup[0]->getLabel());
+                               processedLabels.insert(lookup[0]->getLabel());
+                               userLabels.erase(lookup[0]->getLabel());
                        }
                                
                        //prevent memory leak
-                       if (count != 1) { for (int i = 0; i < lastLookup.size(); i++) {  delete lastLookup[i];  } }
-                       lastLookup = lookup;                    
+                        
+                       lastLabel = lookup[0]->getLabel();                      
 
                        //get next line to process
+                       for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  } 
                        lookup = input->getSharedRAbundVectors();                               
                        count++;
                }
@@ -136,37 +238,35 @@ int HeatMapSimCommand::execute(){
                set<string>::iterator it;
                bool needToRun = false;
                for (it = userLabels.begin(); it != userLabels.end(); it++) {  
-                       cout << "Your file does not include the label "<< *it
-                       if (processedLabels.count(lastLookup[0]->getLabel()) != 1) {
-                               cout << ". I will use " << lastLookup[0]->getLabel() << "." << endl;
+                       mothurOut("Your file does not include the label " + *it)
+                       if (processedLabels.count(lastLabel) != 1) {
+                               mothurOut(". I will use " + lastLabel + "."); mothurOutEndLine();
                                needToRun = true;
                        }else {
-                               cout << ". Please refer to " << lastLookup[0]->getLabel() << "." << endl;
+                               mothurOut(". Please refer to " + lastLabel + "."); mothurOutEndLine();
                        }
                }
                
                //run last line if you need to
                if (needToRun == true)  {
-                       cout << lastLookup[0]->getLabel() << '\t' << count << endl;
-                       heatmap->getPic(lastLookup, heatCalculators);
+                       for (int i = 0; i < lookup.size(); i++) {  if (lookup[i] != NULL) { delete lookup[i]; } } 
+                       lookup = input->getSharedRAbundVectors(lastLabel);                              
+
+                       mothurOut(lookup[0]->getLabel()); mothurOutEndLine();
+                       heatmap->getPic(lookup, heatCalculators);
+                       for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  } 
                }
                
-               for (int i = 0; i < lastLookup.size(); i++) {  delete lastLookup[i];  }
                        
                //reset groups parameter
                globaldata->Groups.clear();  
-               globaldata->setGroups("");
                
                return 0;
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the HeatMapSimCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               errorOut(e, "HeatMapSimCommand", "execute");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the HeatMapSimCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }               
 }
 
 //**********************************************************************************************************************