]> git.donarmstrong.com Git - mothur.git/blobdiff - heatmapcommand.cpp
paralellized summary.shared
[mothur.git] / heatmapcommand.cpp
index a91ef9db9d93b6ad7e65a4705bbe7ad789884a45..fb8e0216530623ea11375784eb898ddfe20ecc58 100644 (file)
@@ -24,7 +24,7 @@ HeatMapCommand::HeatMapCommand(string option) {
                
                else {
                        //valid paramters for this command
-                       string AlignArray[] =  {"groups","label","sorted","scale","outputdir","inputdir"};
+                       string AlignArray[] =  {"groups","label","sorted","scale","fontsize","numotu","outputdir","inputdir"};
                        vector<string> myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string)));
                        
                        OptionParser parser(option);
@@ -40,12 +40,12 @@ HeatMapCommand::HeatMapCommand(string option) {
                        //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(globaldata->inputFileName); //if user entered a file with a path then preserve it  
+                               outputDir += m->hasPath(globaldata->inputFileName); //if user entered a file with a path then preserve it       
                        }
                        
                        //make sure the user has already run the read.otu command
-                       if ((globaldata->getListFile() == "") && (globaldata->getRabundFile() == "") && (globaldata->getSabundFile() == "") && (globaldata->getSharedFile() == "")) {
-                                m->mothurOut("You must read a list, rabund, sabund, or a list and a group, or a shared before you can use the heatmap.bin command."); m->mothurOutEndLine(); abort = true; 
+                       if ((globaldata->getListFile() == "") && (globaldata->getRabundFile() == "") && (globaldata->getSabundFile() == "") && (globaldata->getSharedFile() == "") && (globaldata->getRelAbundFile() == "")) {
+                                m->mothurOut("You must read a list, rabund, sabund, or a list and a group, shared, or relabund file before you can use the heatmap.bin command."); m->mothurOutEndLine(); abort = true; 
                        }
 
                        //check for optional parameter and set defaults
@@ -53,7 +53,7 @@ HeatMapCommand::HeatMapCommand(string option) {
                        label = validParameter.validFile(parameters, "label", false);                   
                        if (label == "not found") { label = ""; }
                        else { 
-                               if(label != "all") {  splitAtDash(label, labels);  allLines = 0;  }
+                               if(label != "all") {  m->splitAtDash(label, labels);  allLines = 0;  }
                                else { allLines = 1;  }
                        }
                        
@@ -66,18 +66,26 @@ HeatMapCommand::HeatMapCommand(string option) {
                        groups = validParameter.validFile(parameters, "groups", false);                 
                        if (groups == "not found") { groups = ""; }
                        else { 
-                               splitAtDash(groups, Groups);
+                               m->splitAtDash(groups, Groups);
                                globaldata->Groups = Groups;
                        }
                        
-                       sorted = validParameter.validFile(parameters, "sorted", false);                 if (sorted == "not found") { sorted = "T"; }
+                       string temp = validParameter.validFile(parameters, "numotu", false);            if (temp == "not found") { temp = "0"; }
+                       convert(temp, numOTU);
+                       
+                       temp = validParameter.validFile(parameters, "fontsize", false);                         if (temp == "not found") { temp = "24"; }
+                       convert(temp, fontSize);
+                       
+                       sorted = validParameter.validFile(parameters, "sorted", false);                         
+                       if (sorted == "not found") { 
+                               //if numOTU is used change default
+                               if (numOTU != 0) { sorted = "topotu"; }
+                               else { sorted = "shared"; }
+                       }
                 
                        scale = validParameter.validFile(parameters, "scale", false);                           if (scale == "not found") { scale = "log10"; }
                        
-                       if (abort == false) {
-                               heatmap = new HeatMap(sorted, scale, outputDir);
-                               format = globaldata->getFormat();
-                       }
+                       if ((sorted != "none") && (sorted != "shared") && (sorted != "topotu") && (sorted != "topgroup")) { m->mothurOut(sorted + " is not a valid sorting option. Sorted options are: none, shared, topotu, topgroup"); m->mothurOutEndLine(); abort=true;  }
                }
 
        }
@@ -92,15 +100,17 @@ HeatMapCommand::HeatMapCommand(string option) {
 void HeatMapCommand::help(){
        try {
                m->mothurOut("The heatmap.bin command can only be executed after a successful read.otu command.\n");
-               m->mothurOut("The heatmap.bin command parameters are groups, sorted, scale label.  No parameters are required.\n");
+               m->mothurOut("The heatmap.bin command parameters are groups, sorted, scale, numotu, fontsize and label.  No parameters are required.\n");
                m->mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like included in your heatmap.\n");
-               m->mothurOut("The sorted parameter allows you to choose to see the file with the shared otus at the top or the otus in the order they appear in your input file. \n");
+               m->mothurOut("The sorted parameter allows you to order the otus displayed, default=shared, meaning display the shared otus first. Other options for sorted are none, meaning the exact representation of your otus, \n");
+               m->mothurOut("topotu, meaning the otus with the greatest abundance when totaled across groups, topgroup, meaning the top otus for each group. \n");
                m->mothurOut("The scale parameter allows you to choose the range of color your bin information will be displayed with.\n");
+               m->mothurOut("The numotu parameter allows you to display only the top N otus, by default all the otus are displayed. You could choose to look at the top 10, by setting numotu=10. The default for sorted is topotu when numotu is used.\n");
                m->mothurOut("The group names are separated by dashes. The label parameter allows you to select what distance levels you would like a heatmap created for, and are also separated by dashes.\n");
+               m->mothurOut("The fontsize parameter allows you to adjust the font size of the picture created, default=24.\n");
                m->mothurOut("The heatmap.bin command should be in the following format: heatmap.bin(groups=yourGroups, sorted=yourSorted, label=yourLabels).\n");
-               m->mothurOut("Example heatmap.bin(groups=A-B-C, sorted=F, scale=log10).\n");
+               m->mothurOut("Example heatmap.bin(groups=A-B-C, sorted=none, scale=log10).\n");
                m->mothurOut("The default value for groups is all the groups in your groupfile, and all labels in your inputfile will be used.\n");
-               m->mothurOut("The default value for sorted is T meaning you want the shared otus on top, you may change it to F meaning the exact representation of your input file.\n");
                m->mothurOut("The default value for scale is log10; your other options are log2 and linear.\n");
                m->mothurOut("The heatmap.bin command outputs a .svg file for each label you specify.\n");
                m->mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n");
@@ -115,10 +125,6 @@ void HeatMapCommand::help(){
 //**********************************************************************************************************************
 
 HeatMapCommand::~HeatMapCommand(){
-       if (abort == false) {
-               delete read;
-               delete heatmap;
-       }
 }
 
 //**********************************************************************************************************************
@@ -127,37 +133,45 @@ int HeatMapCommand::execute(){
        try {
        
                if (abort == true) { return 0; }
+               
+               heatmap = new HeatMap(sorted, scale, numOTU, fontSize, outputDir);
+               format = globaldata->getFormat();
 
                string lastLabel;
-       
+               
+               read = new ReadOTUFile(globaldata->inputFileName);      
+               read->read(&*globaldata); 
+               input = globaldata->ginput;
+               
                if (format == "sharedfile") {
                        //you have groups
-                       read = new ReadOTUFile(globaldata->inputFileName);      
-                       read->read(&*globaldata); 
-                       
-                       input = globaldata->ginput;
                        lookup = input->getSharedRAbundVectors();
                        lastLabel = lookup[0]->getLabel();
        
                }else if ((format == "list") || (format == "rabund") || (format == "sabund")) {
                        //you are using just a list file and have only one group
-                       read = new ReadOTUFile(globaldata->inputFileName);      
-                       read->read(&*globaldata); 
-               
                        rabund = globaldata->rabund;
                        lastLabel = rabund->getLabel();
-                       input = globaldata->ginput;     
-
+               }else if (format == "relabund") {
+                       //you have groups
+                       lookupFloat = input->getSharedRAbundFloatVectors();
+                       lastLabel = lookupFloat[0]->getLabel();
                }
                
                //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 = labels;
 
-               if ((format != "list") && (format != "rabund") && (format != "sabund")) {       
+               if (format == "sharedfile") {   
                
                        //as long as you are not at the end of the file or done wih the lines you want
                        while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
+                               if (m->control_pressed) {
+                                       for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  }
+                                       for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                                       globaldata->Groups.clear(); 
+                                       delete read; delete heatmap; return 0;
+                               }
                
                                if(allLines == 1 || labels.count(lookup[0]->getLabel()) == 1){                  
        
@@ -168,7 +182,7 @@ int HeatMapCommand::execute(){
                                        userLabels.erase(lookup[0]->getLabel());
                                }
                                
-                               if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+                               if ((m->anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
                                        string saveLabel = lookup[0]->getLabel();
                                
                                        for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  }  
@@ -186,12 +200,19 @@ int HeatMapCommand::execute(){
                                
                                lastLabel = lookup[0]->getLabel();
                                //prevent memory leak
-                               for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  }
+                               for (int i = 0; i < lookup.size(); i++) {  delete lookup[i]; lookup[i] = NULL; }
                                                        
                                //get next line to process
                                lookup = input->getSharedRAbundVectors();                               
                        }
                        
+                       
+                       if (m->control_pressed) {
+                               for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                               globaldata->Groups.clear(); 
+                               delete read; delete heatmap; return 0;
+                       }
+
                        //output error messages about any remaining user labels
                        set<string>::iterator it;
                        bool needToRun = false;
@@ -215,14 +236,16 @@ int HeatMapCommand::execute(){
                                for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  }
                        }
                
-                       
-                       
                        //reset groups parameter
                        globaldata->Groups.clear();  
                        
-               }else{
+               }else if ((format == "list") || (format == "rabund") || (format == "sabund")) {
        
                        while((rabund != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
+                               if (m->control_pressed) {   
+                                       for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                                       delete rabund;  delete read; delete heatmap; return 0;  
+                               }
 
                                if(allLines == 1 || labels.count(rabund->getLabel()) == 1){                     
        
@@ -233,7 +256,7 @@ int HeatMapCommand::execute(){
                                        userLabels.erase(rabund->getLabel());
                                }
                                
-                               if ((anyLabelsToProcess(rabund->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+                               if ((m->anyLabelsToProcess(rabund->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
                                        string saveLabel = rabund->getLabel();
                                        
                                        delete rabund;
@@ -256,6 +279,11 @@ int HeatMapCommand::execute(){
                                rabund = input->getRAbundVector();
                        }
                        
+                       if (m->control_pressed) {
+                               for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                               delete read; delete heatmap; return 0;
+                       }
+
                        //output error messages about any remaining user labels
                        set<string>::iterator it;
                        bool needToRun = false;
@@ -280,15 +308,100 @@ int HeatMapCommand::execute(){
                                delete rabund; globaldata->rabund = NULL;
                        }
                
+               }else {
+               
+                       //as long as you are not at the end of the file or done wih the lines you want
+                       while((lookupFloat[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
+                               if (m->control_pressed) {
+                                       for (int i = 0; i < lookupFloat.size(); i++) {  delete lookupFloat[i];  }
+                                       for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                                       globaldata->Groups.clear(); 
+                                       delete read; delete heatmap; return 0;
+                               }
+               
+                               if(allLines == 1 || labels.count(lookupFloat[0]->getLabel()) == 1){                     
+       
+                                       m->mothurOut(lookupFloat[0]->getLabel()); m->mothurOutEndLine();
+                                       outputNames.push_back(heatmap->getPic(lookupFloat));
+                                       
+                                       processedLabels.insert(lookupFloat[0]->getLabel());
+                                       userLabels.erase(lookupFloat[0]->getLabel());
+                               }
+                               
+                               if ((m->anyLabelsToProcess(lookupFloat[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+                                       string saveLabel = lookupFloat[0]->getLabel();
+                               
+                                       for (int i = 0; i < lookupFloat.size(); i++) {  delete lookupFloat[i];  }  
+                                       lookupFloat = input->getSharedRAbundFloatVectors(lastLabel);
+                                       m->mothurOut(lookupFloat[0]->getLabel()); m->mothurOutEndLine();
+                                       
+                                       outputNames.push_back(heatmap->getPic(lookupFloat));
+                                       
+                                       processedLabels.insert(lookupFloat[0]->getLabel());
+                                       userLabels.erase(lookupFloat[0]->getLabel());
+                                       
+                                       //restore real lastlabel to save below
+                                       lookupFloat[0]->setLabel(saveLabel);
+                               }
+                               
+                               lastLabel = lookupFloat[0]->getLabel();
+                               //prevent memory leak
+                               for (int i = 0; i < lookupFloat.size(); i++) {  delete lookupFloat[i]; lookupFloat[i] = NULL; }
+                                                       
+                               //get next line to process
+                               lookupFloat = input->getSharedRAbundFloatVectors();                             
+                       }
+                       
+                       
+                       if (m->control_pressed) {
+                               for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                               globaldata->Groups.clear(); 
+                               delete read; delete heatmap; return 0;
+                       }
+
+                       //output error messages about any remaining user labels
+                       set<string>::iterator it;
+                       bool needToRun = false;
+                       for (it = userLabels.begin(); it != userLabels.end(); it++) {  
+                               m->mothurOut("Your file does not include the label " + *it); 
+                               if (processedLabels.count(lastLabel) != 1) {
+                                       m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
+                                       needToRun = true;
+                               }else {
+                                       m->mothurOut(". Please refer to " + lastLabel + "."); m->mothurOutEndLine();
+                               }
+                       }
+               
+                       //run last label if you need to
+                       if (needToRun == true)  {
+                               for (int i = 0; i < lookupFloat.size(); i++) { if (lookupFloat[i] != NULL) { delete lookupFloat[i]; } }  
+                               lookupFloat = input->getSharedRAbundFloatVectors(lastLabel);
+                               
+                               m->mothurOut(lookupFloat[0]->getLabel()); m->mothurOutEndLine();
+                               outputNames.push_back(heatmap->getPic(lookupFloat));
+                               for (int i = 0; i < lookupFloat.size(); i++) {  delete lookupFloat[i];  }
+                       }
+               
+                       //reset groups parameter
+                       globaldata->Groups.clear();  
+
                }
                
                globaldata->rabund = NULL;
                delete input; globaldata->ginput = NULL;
                
+               if (m->control_pressed) {
+                       for (int i = 0; i < outputNames.size(); i++) {  if (outputNames[i] != "control") {  remove(outputNames[i].c_str());  } }
+                       delete read; delete heatmap; return 0;
+               }
+               
                m->mothurOutEndLine();
                m->mothurOut("Output File Names: "); m->mothurOutEndLine();
                for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
                m->mothurOutEndLine();
+       
+               delete read;
+               delete heatmap;
 
                return 0;
        }