rarefactsharedcommand.cpp

   1 /*
   2  *  rarefactsharedcommand.cpp
   3  *  Dotur
   4  *
   5  *  Created by Sarah Westcott on 1/6/09.
   6  *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
   7  *
   8  */
   9
  10 #include "rarefactsharedcommand.h"
  11 #include "sharedsobs.h"
  12 #include "sharednseqs.h"
  13
  14 //**********************************************************************************************************************
  15
  16 RareFactSharedCommand::RareFactSharedCommand(string option){
  17         try {
  18                 globaldata = GlobalData::getInstance();
  19                 abort = false;
  20                 allLines = 1;
  21                 lines.clear();
  22                 labels.clear();
  23                 Estimators.clear();
  24
  25                 //allow user to run help
  26                 if(option == "help") { validCalculator = new ValidCalculators(); help(); abort = true; }
  27
  28                 else {
  29                         //valid paramters for this command
  30                         string Array[] =  {"iters","line","label","calc","groups"};
  31                         vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  32
  33                         parser = new OptionParser();
  34                         parser->parse(option, parameters);  delete parser;
  35
  36                         ValidParameters* validParameter = new ValidParameters();
  37
  38                         //check to make sure all parameters are valid for command
  39                         for (it = parameters.begin(); it != parameters.end(); it++) {
  40                                 if (validParameter->isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
  41                         }
  42
  43                         //make sure the user has already run the read.otu command
  44                         if (globaldata->getSharedFile() == "") {
  45                                 if (globaldata->getListFile() == "") { cout << "You must read a list and a group, or a shared before you can use the collect.shared command." << endl; abort = true; }
  46                                 else if (globaldata->getGroupFile() == "") { cout << "You must read a list and a group, or a shared before you can use the collect.shared command." << endl; abort = true; }
  47                         }
  48
  49
  50                         //check for optional parameter and set defaults
  51                         // ...at some point should added some additional type checking...
  52                         line = validParameter->validFile(parameters, "line", false);
  53                         if (line == "not found") { line = "";  }
  54                         else {
  55                                 if(line != "all") {  splitAtDash(line, lines);  allLines = 0;  }
  56                                 else { allLines = 1;  }
  57                         }
  58
  59                         label = validParameter->validFile(parameters, "label", false);
  60                         if (label == "not found") { label = ""; }
  61                         else {
  62                                 if(label != "all") {  splitAtDash(label, labels);  allLines = 0;  }
  63                                 else { allLines = 1;  }
  64                         }
  65
  66                         //make sure user did not use both the line and label parameters
  67                         if ((line != "") && (label != "")) { cout << "You cannot use both the line and label parameters at the same time. " << endl; abort = true; }
  68                         //if the user has not specified any line or labels use the ones from read.otu
  69                         else if((line == "") && (label == "")) {
  70                                 allLines = globaldata->allLines;
  71                                 labels = globaldata->labels;
  72                                 lines = globaldata->lines;
  73                         }
  74
  75                         calc = validParameter->validFile(parameters, "calc", false);
  76                         if (calc == "not found") { calc = "sharedobserved";  }
  77                         else {
  78                                  if (calc == "default")  {  calc = "sharedobserved";  }
  79                         }
  80                         splitAtDash(calc, Estimators);
  81
  82                         groups = validParameter->validFile(parameters, "groups", false);
  83                         if (groups == "not found") { groups = ""; }
  84                         else {
  85                                 splitAtDash(groups, Groups);
  86                                 globaldata->Groups = Groups;
  87                         }
  88
  89                         string temp;
  90                         temp = validParameter->validFile(parameters, "iters", false);                   if (temp == "not found") { temp = "1000"; }
  91                         convert(temp, nIters);
  92
  93                         delete validParameter;
  94
  95                         if (abort == false) {
  96
  97                                 string fileNameRoot = getRootName(globaldata->inputFileName);
  98                                 format = globaldata->getFormat();
  99                                 int i;
 100
 101                                 validCalculator = new ValidCalculators();
 102
 103                                 for (i=0; i<Estimators.size(); i++) {
 104                                         if (validCalculator->isValidCalculator("sharedrarefaction", Estimators[i]) == true) {
 105                                                 if (Estimators[i] == "sharedobserved") {
 106                                                         rDisplays.push_back(new RareDisplay(new SharedSobs(), new SharedThreeColumnFile(fileNameRoot+"shared.rarefaction", "")));
 107                                                 }else if (Estimators[i] == "sharednseqs") {
 108                                                         rDisplays.push_back(new RareDisplay(new SharedNSeqs(), new SharedThreeColumnFile(fileNameRoot+"shared.r_nseqs", "")));
 109                                                 }
 110                                         }
 111                                 }
 112                         }
 113
 114                 }
 115
 116         }
 117         catch(exception& e) {
 118                 cout << "Standard Error: " << e.what() << " has occurred in the RareFactSharedCommand class Function RareFactSharedCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 119                 exit(1);
 120         }
 121         catch(...) {
 122                 cout << "An unknown error has occurred in the RareFactSharedCommand class function RareFactSharedCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 123                 exit(1);
 124         }
 125
 126 }
 127
 128 //**********************************************************************************************************************
 129
 130 void RareFactSharedCommand::help(){
 131         try {
 132                 cout << "The rarefaction.shared command can only be executed after a successful read.otu command." << "\n";
 133                 cout << "The rarefaction.shared command parameters are label, line, iters, groups and calc.  No parameters are required, but you may not use " << "\n";
 134                 cout << "both the line and label parameters at the same time. The rarefaction command should be in the following format: " << "\n";
 135                 cout << "rarefaction.shared(label=yourLabel, line=yourLines, iters=yourIters, calc=yourEstimators, groups=yourGroups)." << "\n";
 136                 cout << "Example rarefaction.shared(label=unique-.01-.03, line=0-5-10, iters=10000, groups=B-C, calc=sharedobserved)." << "\n";
 137                 cout << "The default values for iters is 1000, freq is 100, and calc is sharedobserved which calculates the shared rarefaction curve for the observed richness." << "\n";
 138                 cout << "The default value for groups is all the groups in your groupfile." << "\n";
 139                 validCalculator->printCalc("sharedrarefaction", cout);
 140                 cout << "The label and line parameters are used to analyze specific lines in your input." << "\n";
 141                 cout << "The groups parameter allows you to specify which of the groups in your groupfile you would like analyzed.  You must enter at least 2 valid groups." << "\n";
 142                 cout << "Note: No spaces between parameter labels (i.e. freq), '=' and parameters (i.e.yourFreq)." << "\n" << "\n";
 143         }
 144         catch(exception& e) {
 145                 cout << "Standard Error: " << e.what() << " has occurred in the RareFactSharedCommand class Function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 146                 exit(1);
 147         }
 148         catch(...) {
 149                 cout << "An unknown error has occurred in the RareFactSharedCommand class function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 150                 exit(1);
 151         }
 152 }
 153
 154 //**********************************************************************************************************************
 155
 156 RareFactSharedCommand::~RareFactSharedCommand(){
 157         delete input;
 158         delete rCurve;
 159         delete read;
 160         delete validCalculator;
 161 }
 162
 163 //**********************************************************************************************************************
 164
 165 int RareFactSharedCommand::execute(){
 166         try {
 167
 168                 if (abort == true) { return 0; }
 169
 170                 int count = 1;
 171
 172                 //if the users entered no valid calculators don't execute command
 173                 if (rDisplays.size() == 0) { return 0; }
 174
 175                 read = new ReadOTUFile(globaldata->inputFileName);
 176                 read->read(&*globaldata);
 177
 178                 input = globaldata->ginput;
 179                 lookup = input->getSharedRAbundVectors();
 180                 vector<SharedRAbundVector*> lastLookup = lookup;
 181
 182                 if (lookup.size() < 2) {
 183                         cout << "I cannot run the command without at least 2 valid groups.";
 184                         for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
 185                         return 0;
 186                 }
 187
 188                 //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
 189                 set<string> processedLabels;
 190                 set<string> userLabels = labels;
 191                 set<int> userLines = lines;
 192
 193                 //as long as you are not at the end of the file or done wih the lines you want
 194                 while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0) || (userLines.size() != 0))) {
 195
 196                         if(allLines == 1 || lines.count(count) == 1 || labels.count(lookup[0]->getLabel()) == 1){
 197
 198                                 rCurve = new Rarefact(lookup, rDisplays);
 199                                 rCurve->getSharedCurve(freq, nIters);
 200                                 delete rCurve;
 201
 202                                 cout << lookup[0]->getLabel() << '\t' << count << endl;
 203                                 processedLabels.insert(lookup[0]->getLabel());
 204                                 userLabels.erase(lookup[0]->getLabel());
 205                                 userLines.erase(count);
 206                         }
 207
 208                         if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLookup[0]->getLabel()) != 1)) {
 209                                         cout << lastLookup[0]->getLabel() << '\t' << count << endl;
 210                                         rCurve = new Rarefact(lastLookup, rDisplays);
 211                                         rCurve->getSharedCurve(freq, nIters);
 212                                         delete rCurve;
 213
 214                                         processedLabels.insert(lastLookup[0]->getLabel());
 215                                         userLabels.erase(lastLookup[0]->getLabel());
 216                         }
 217
 218                         //prevent memory leak
 219                         if (count != 1) { for (int i = 0; i < lastLookup.size(); i++) {  delete lastLookup[i];  } }
 220                         lastLookup = lookup;
 221
 222                         //get next line to process
 223                         lookup = input->getSharedRAbundVectors();
 224                         count++;
 225                 }
 226
 227                 //output error messages about any remaining user labels
 228                 set<string>::iterator it;
 229                 bool needToRun = false;
 230                 for (it = userLabels.begin(); it != userLabels.end(); it++) {
 231                         cout << "Your file does not include the label "<< *it;
 232                         if (processedLabels.count(lastLookup[0]->getLabel()) != 1) {
 233                                 cout << ". I will use " << lastLookup[0]->getLabel() << "." << endl;
 234                                 needToRun = true;
 235                         }else {
 236                                 cout << ". Please refer to " << lastLookup[0]->getLabel() << "." << endl;
 237                         }
 238                 }
 239
 240                 //run last line if you need to
 241                 if (needToRun == true)  {
 242                         cout << lastLookup[0]->getLabel() << '\t' << count << endl;
 243                         rCurve = new Rarefact(lastLookup, rDisplays);
 244                         rCurve->getSharedCurve(freq, nIters);
 245                         delete rCurve;
 246                 }
 247
 248                 for (int i = 0; i < lastLookup.size(); i++) {  delete lastLookup[i];  }
 249
 250                 for(int i=0;i<rDisplays.size();i++){    delete rDisplays[i];    }
 251
 252                 //reset groups parameter
 253                 globaldata->Groups.clear();
 254
 255                 return 0;
 256         }
 257         catch(exception& e) {
 258                 cout << "Standard Error: " << e.what() << " has occurred in the RareFactSharedCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 259                 exit(1);
 260         }
 261         catch(...) {
 262                 cout << "An unknown error has occurred in the RareFactSharedCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 263                 exit(1);
 264         }
 265 }
 266
 267
 268 //**********************************************************************************************************************