rarefactcommand.cpp

   1 /*
   2  *  rarefactcommand.cpp
   3  *  Dotur
   4  *
   5  *  Created by Sarah Westcott on 1/2/09.
   6  *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
   7  *
   8  */
   9
  10 #include "rarefactcommand.h"
  11 #include "ace.h"
  12 #include "sobs.h"
  13 #include "nseqs.h"
  14 #include "chao1.h"
  15 #include "bootstrap.h"
  16 #include "simpson.h"
  17 #include "npshannon.h"
  18 #include "shannon.h"
  19 #include "jackknife.h"
  20 #include "coverage.h"
  21
  22 //**********************************************************************************************************************
  23
  24
  25 RareFactCommand::RareFactCommand(string option)  {
  26         try {
  27                 globaldata = GlobalData::getInstance();
  28                 abort = false;
  29                 allLines = 1;
  30                 labels.clear();
  31                 Estimators.clear();
  32
  33                 //allow user to run help
  34                 if(option == "help") { validCalculator = new ValidCalculators(); help(); delete validCalculator; abort = true; }
  35
  36                 else {
  37                         //valid paramters for this command
  38                         string Array[] =  {"iters","freq","label","calc","abund","outputdir","inputdir"};
  39                         vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  40
  41                         OptionParser parser(option);
  42                         map<string,string> parameters = parser.getParameters();
  43
  44                         ValidParameters validParameter;
  45
  46                         //check to make sure all parameters are valid for command
  47                         for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) {
  48                                 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
  49                         }
  50
  51                         //if the user changes the output directory command factory will send this info to us in the output parameter
  52                         outputDir = validParameter.validFile(parameters, "outputdir", false);           if (outputDir == "not found"){
  53                                 outputDir = "";
  54                                 outputDir += hasPath(globaldata->inputFileName); //if user entered a file with a path then preserve it
  55                         }
  56
  57                         //make sure the user has already run the read.otu command
  58                         if ((globaldata->getSharedFile() == "") && (globaldata->getListFile() == "") && (globaldata->getRabundFile() == "") && (globaldata->getSabundFile() == "")) { m->mothurOut("You must read a list, sabund, rabund or shared file before you can use the rarefact.single command."); m->mothurOutEndLine(); abort = true; }
  59
  60                         //check for optional parameter and set defaults
  61                         // ...at some point should added some additional type checking...
  62                         label = validParameter.validFile(parameters, "label", false);
  63                         if (label == "not found") { label = ""; }
  64                         else {
  65                                 if(label != "all") {  splitAtDash(label, labels);  allLines = 0;  }
  66                                 else { allLines = 1;  }
  67                         }
  68
  69                         //if the user has not specified any labels use the ones from read.otu
  70                         if(label == "") {
  71                                 allLines = globaldata->allLines;
  72                                 labels = globaldata->labels;
  73                         }
  74
  75                         calc = validParameter.validFile(parameters, "calc", false);
  76                         if (calc == "not found") { calc = "sobs";  }
  77                         else {
  78                                  if (calc == "default")  {  calc = "sobs";  }
  79                         }
  80                         splitAtDash(calc, Estimators);
  81
  82                         string temp;
  83                         temp = validParameter.validFile(parameters, "freq", false);                     if (temp == "not found") { temp = "100"; }
  84                         convert(temp, freq);
  85
  86                         temp = validParameter.validFile(parameters, "abund", false);                    if (temp == "not found") { temp = "10"; }
  87                         convert(temp, abund);
  88
  89                         temp = validParameter.validFile(parameters, "iters", false);                    if (temp == "not found") { temp = "1000"; }
  90                         convert(temp, nIters);
  91                 }
  92
  93         }
  94         catch(exception& e) {
  95                 m->errorOut(e, "RareFactCommand", "RareFactCommand");
  96                 exit(1);
  97         }
  98 }
  99 //**********************************************************************************************************************
 100
 101 void RareFactCommand::help(){
 102         try {
 103                 m->mothurOut("The rarefaction.single command can only be executed after a successful read.otu WTIH ONE EXECEPTION.\n");
 104                 m->mothurOut("The rarefaction.single command can be executed after a successful cluster command.  It will use the .list file from the output of the cluster.\n");
 105                 m->mothurOut("The rarefaction.single command parameters are label, iters, freq, calc and abund.  No parameters are required. \n");
 106                 m->mothurOut("The freq parameter is used indicate when to output your data, by default it is set to 100. But you can set it to a percentage of the number of sequence. For example freq=0.10, means 10%. \n");
 107                 m->mothurOut("The rarefaction.single command should be in the following format: \n");
 108                 m->mothurOut("rarefaction.single(label=yourLabel, iters=yourIters, freq=yourFreq, calc=yourEstimators).\n");
 109                 m->mothurOut("Example rarefaction.single(label=unique-.01-.03, iters=10000, freq=10, calc=sobs-rchao-race-rjack-rbootstrap-rshannon-rnpshannon-rsimpson).\n");
 110                 m->mothurOut("The default values for iters is 1000, freq is 100, and calc is rarefaction which calculates the rarefaction curve for the observed richness.\n");
 111                 validCalculator->printCalc("rarefaction", cout);
 112                 m->mothurOut("The label parameter is used to analyze specific labels in your input.\n");
 113                 m->mothurOut("Note: No spaces between parameter labels (i.e. freq), '=' and parameters (i.e.yourFreq).\n\n");
 114         }
 115         catch(exception& e) {
 116                 m->errorOut(e, "RareFactCommand", "help");
 117                 exit(1);
 118         }
 119 }
 120
 121 //**********************************************************************************************************************
 122
 123 RareFactCommand::~RareFactCommand(){}
 124
 125 //**********************************************************************************************************************
 126
 127 int RareFactCommand::execute(){
 128         try {
 129
 130                 if (abort == true) { return 0; }
 131
 132                 vector<string> outputNames;
 133
 134                 string hadShared = "";
 135                 if ((globaldata->getFormat() != "sharedfile")) { inputFileNames.push_back(globaldata->inputFileName);  }
 136                 else { hadShared = globaldata->getSharedFile(); inputFileNames = parseSharedFile(globaldata->getSharedFile());  globaldata->setFormat("rabund");  }
 137
 138                 if (m->control_pressed) { if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  } return 0; }
 139
 140                 for (int p = 0; p < inputFileNames.size(); p++) {
 141
 142                         string fileNameRoot = outputDir + getRootName(getSimpleName(inputFileNames[p]));
 143                         globaldata->inputFileName = inputFileNames[p];
 144
 145                         if (m->control_pressed) { if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  } return 0; }
 146
 147                         if (inputFileNames.size() > 1) {
 148                                 m->mothurOutEndLine(); m->mothurOut("Processing group " + groups[p]); m->mothurOutEndLine(); m->mothurOutEndLine();
 149                         }
 150                         int i;
 151                         validCalculator = new ValidCalculators();
 152
 153
 154                         for (i=0; i<Estimators.size(); i++) {
 155                                 if (validCalculator->isValidCalculator("rarefaction", Estimators[i]) == true) {
 156                                         if (Estimators[i] == "sobs") {
 157                                                 rDisplays.push_back(new RareDisplay(new Sobs(), new ThreeColumnFile(fileNameRoot+"rarefaction")));
 158                                                 outputNames.push_back(fileNameRoot+"rarefaction");
 159                                         }else if (Estimators[i] == "chao") {
 160                                                 rDisplays.push_back(new RareDisplay(new Chao1(), new ThreeColumnFile(fileNameRoot+"r_chao")));
 161                                                 outputNames.push_back(fileNameRoot+"r_chao");
 162                                         }else if (Estimators[i] == "ace") {
 163                                                 if(abund < 5)
 164                                                         abund = 10;
 165                                                 rDisplays.push_back(new RareDisplay(new Ace(abund), new ThreeColumnFile(fileNameRoot+"r_ace")));
 166                                                 outputNames.push_back(fileNameRoot+"r_ace");
 167                                         }else if (Estimators[i] == "jack") {
 168                                                 rDisplays.push_back(new RareDisplay(new Jackknife(), new ThreeColumnFile(fileNameRoot+"r_jack")));
 169                                                 outputNames.push_back(fileNameRoot+"r_jack");
 170                                         }else if (Estimators[i] == "shannon") {
 171                                                 rDisplays.push_back(new RareDisplay(new Shannon(), new ThreeColumnFile(fileNameRoot+"r_shannon")));
 172                                                 outputNames.push_back(fileNameRoot+"r_shannon");
 173                                         }else if (Estimators[i] == "npshannon") {
 174                                                 rDisplays.push_back(new RareDisplay(new NPShannon(), new ThreeColumnFile(fileNameRoot+"r_npshannon")));
 175                                                 outputNames.push_back(fileNameRoot+"r_npshannon");
 176                                         }else if (Estimators[i] == "simpson") {
 177                                                 rDisplays.push_back(new RareDisplay(new Simpson(), new ThreeColumnFile(fileNameRoot+"r_simpson")));
 178                                                 outputNames.push_back(fileNameRoot+"r_simpson");
 179                                         }else if (Estimators[i] == "bootstrap") {
 180                                                 rDisplays.push_back(new RareDisplay(new Bootstrap(), new ThreeColumnFile(fileNameRoot+"r_bootstrap")));
 181                                                 outputNames.push_back(fileNameRoot+"r_bootstrap");
 182                                         }else if (Estimators[i] == "coverage") {
 183                                                 rDisplays.push_back(new RareDisplay(new Coverage(), new ThreeColumnFile(fileNameRoot+"r_coverage")));
 184                                                 outputNames.push_back(fileNameRoot+"r_coverage");
 185                                         }else if (Estimators[i] == "nseqs") {
 186                                                 rDisplays.push_back(new RareDisplay(new NSeqs(), new ThreeColumnFile(fileNameRoot+"r_nseqs")));
 187                                                 outputNames.push_back(fileNameRoot+"r_nseqs");
 188                                         }
 189                                 }
 190                         }
 191
 192
 193                         //if the users entered no valid calculators don't execute command
 194                         if (rDisplays.size() == 0) { for(int i=0;i<rDisplays.size();i++){       delete rDisplays[i];    } delete validCalculator; return 0; }
 195
 196                         read = new ReadOTUFile(globaldata->inputFileName);
 197                         read->read(&*globaldata);
 198
 199                         order = globaldata->gorder;
 200                         string lastLabel = order->getLabel();
 201                         input = globaldata->ginput;
 202
 203                         //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
 204                         set<string> processedLabels;
 205                         set<string> userLabels = labels;
 206
 207                         if (m->control_pressed) { if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  } for(int i=0;i<rDisplays.size();i++){    delete rDisplays[i];    } delete validCalculator; delete read; delete input; globaldata->ginput = NULL; delete order; globaldata->gorder = NULL; for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; }
 208
 209                         //as long as you are not at the end of the file or done wih the lines you want
 210                         while((order != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
 211
 212                                 if (m->control_pressed) { if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  } for(int i=0;i<rDisplays.size();i++){    delete rDisplays[i];    } delete validCalculator; delete read; delete input; globaldata->ginput = NULL; delete order; globaldata->gorder = NULL; for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; }
 213
 214
 215                                 if(allLines == 1 || labels.count(order->getLabel()) == 1){
 216
 217                                         m->mothurOut(order->getLabel()); m->mothurOutEndLine();
 218                                         rCurve = new Rarefact(order, rDisplays);
 219                                         rCurve->getCurve(freq, nIters);
 220                                         delete rCurve;
 221
 222                                         processedLabels.insert(order->getLabel());
 223                                         userLabels.erase(order->getLabel());
 224                                 }
 225
 226                                 if ((anyLabelsToProcess(order->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
 227                                         string saveLabel = order->getLabel();
 228
 229                                         delete order;
 230                                         order = (input->getOrderVector(lastLabel));
 231
 232                                         m->mothurOut(order->getLabel()); m->mothurOutEndLine();
 233                                         rCurve = new Rarefact(order, rDisplays);
 234                                         rCurve->getCurve(freq, nIters);
 235                                         delete rCurve;
 236
 237                                         processedLabels.insert(order->getLabel());
 238                                         userLabels.erase(order->getLabel());
 239
 240                                         //restore real lastlabel to save below
 241                                         order->setLabel(saveLabel);
 242                                 }
 243
 244                                 lastLabel = order->getLabel();
 245
 246                                 delete order;
 247                                 order = (input->getOrderVector());
 248                         }
 249
 250                         if (m->control_pressed) { if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  } for(int i=0;i<rDisplays.size();i++){    delete rDisplays[i];    } delete validCalculator; delete read; delete input; globaldata->ginput = NULL; for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str()); }  return 0; }
 251
 252                         //output error messages about any remaining user labels
 253                         set<string>::iterator it;
 254                         bool needToRun = false;
 255                         for (it = userLabels.begin(); it != userLabels.end(); it++) {
 256                                 m->mothurOut("Your file does not include the label " + *it);
 257                                 if (processedLabels.count(lastLabel) != 1) {
 258                                         m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
 259                                         needToRun = true;
 260                                 }else {
 261                                         m->mothurOut(". Please refer to " + lastLabel + "."); m->mothurOutEndLine();
 262                                 }
 263                         }
 264
 265                         if (m->control_pressed) { if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  } for(int i=0;i<rDisplays.size();i++){    delete rDisplays[i];    } delete validCalculator; delete read; delete input; globaldata->ginput = NULL;  for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; }
 266
 267                         //run last label if you need to
 268                         if (needToRun == true)  {
 269                                 if (order != NULL) {    delete order;   }
 270                                 order = (input->getOrderVector(lastLabel));
 271
 272                                 m->mothurOut(order->getLabel()); m->mothurOutEndLine();
 273                                 rCurve = new Rarefact(order, rDisplays);
 274                                 rCurve->getCurve(freq, nIters);
 275                                 delete rCurve;
 276
 277                                 delete order;
 278                         }
 279
 280
 281                         for(int i=0;i<rDisplays.size();i++){    delete rDisplays[i];    }
 282                         rDisplays.clear();
 283                         globaldata->gorder = NULL;
 284                         delete input;  globaldata->ginput = NULL;
 285                         delete read;
 286                         delete validCalculator;
 287
 288                 }
 289
 290                 if (hadShared != "") {  globaldata->setSharedFile(hadShared); globaldata->setFormat("sharedfile");  }
 291
 292                 if (m->control_pressed) {  for (int i = 0; i < outputNames.size(); i++) {       remove(outputNames[i].c_str()); } return 0; }
 293
 294                 m->mothurOutEndLine();
 295                 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
 296                 for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
 297                 m->mothurOutEndLine();
 298
 299                 return 0;
 300         }
 301         catch(exception& e) {
 302                 m->errorOut(e, "RareFactCommand", "execute");
 303                 exit(1);
 304         }
 305 }
 306 //**********************************************************************************************************************
 307 vector<string> RareFactCommand::parseSharedFile(string filename) {
 308         try {
 309                 vector<string> filenames;
 310
 311                 map<string, ofstream*> filehandles;
 312                 map<string, ofstream*>::iterator it3;
 313
 314
 315                 //read first line
 316                 read = new ReadOTUFile(filename);
 317                 read->read(&*globaldata);
 318
 319                 input = globaldata->ginput;
 320                 vector<SharedRAbundVector*> lookup = input->getSharedRAbundVectors();
 321
 322                 string sharedFileRoot = getRootName(filename);
 323
 324                 //clears file before we start to write to it below
 325                 for (int i=0; i<lookup.size(); i++) {
 326                         remove((sharedFileRoot + lookup[i]->getGroup() + ".rabund").c_str());
 327                         filenames.push_back((sharedFileRoot + lookup[i]->getGroup() + ".rabund"));
 328                 }
 329
 330                 ofstream* temp;
 331                 for (int i=0; i<lookup.size(); i++) {
 332                         temp = new ofstream;
 333                         filehandles[lookup[i]->getGroup()] = temp;
 334                         groups.push_back(lookup[i]->getGroup());
 335                 }
 336
 337                 while(lookup[0] != NULL) {
 338
 339                         for (int i = 0; i < lookup.size(); i++) {
 340                                 RAbundVector rav = lookup[i]->getRAbundVector();
 341                                 openOutputFileAppend(sharedFileRoot + lookup[i]->getGroup() + ".rabund", *(filehandles[lookup[i]->getGroup()]));
 342                                 rav.print(*(filehandles[lookup[i]->getGroup()]));
 343                                 (*(filehandles[lookup[i]->getGroup()])).close();
 344                         }
 345
 346                         for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  }
 347                         lookup = input->getSharedRAbundVectors();
 348                 }
 349
 350                 //free memory
 351                 for (it3 = filehandles.begin(); it3 != filehandles.end(); it3++) {
 352                         delete it3->second;
 353                 }
 354                 delete read;
 355                 delete input;
 356                 globaldata->ginput = NULL;
 357
 358                 return filenames;
 359         }
 360         catch(exception& e) {
 361                 m->errorOut(e, "RareFactCommand", "parseSharedFile");
 362                 exit(1);
 363         }
 364 }
 365 //**********************************************************************************************************************
 366
 367
 368