hclustercommand.cpp

   1 /*
   2  *  hclustercommand.cpp
   3  *  Mothur
   4  *
   5  *  Created by westcott on 10/13/09.
   6  *  Copyright 2009 Schloss Lab. All rights reserved.
   7  *
   8  */
   9
  10 #include "hclustercommand.h"
  11
  12 //**********************************************************************************************************************
  13 vector<string> HClusterCommand::getValidParameters(){
  14         try {
  15                 string Array[] =  {"cutoff","hard","precision","method","phylip","column","name","sorted","showabund","timing","outputdir","inputdir"};
  16                 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  17                 return myArray;
  18         }
  19         catch(exception& e) {
  20                 m->errorOut(e, "HClusterCommand", "getValidParameters");
  21                 exit(1);
  22         }
  23 }
  24 //**********************************************************************************************************************
  25 HClusterCommand::HClusterCommand(){
  26         try {
  27                 abort = true;
  28                 //initialize outputTypes
  29                 vector<string> tempOutNames;
  30                 outputTypes["list"] = tempOutNames;
  31                 outputTypes["rabund"] = tempOutNames;
  32                 outputTypes["sabund"] = tempOutNames;
  33         }
  34         catch(exception& e) {
  35                 m->errorOut(e, "HClusterCommand", "HClusterCommand");
  36                 exit(1);
  37         }
  38 }
  39 //**********************************************************************************************************************
  40 vector<string> HClusterCommand::getRequiredParameters(){
  41         try {
  42                 string Array[] =  {"phylip","column","or"};
  43                 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  44                 return myArray;
  45         }
  46         catch(exception& e) {
  47                 m->errorOut(e, "HClusterCommand", "getRequiredParameters");
  48                 exit(1);
  49         }
  50 }
  51 //**********************************************************************************************************************
  52 vector<string> HClusterCommand::getRequiredFiles(){
  53         try {
  54                 vector<string> myArray;
  55                 return myArray;
  56         }
  57         catch(exception& e) {
  58                 m->errorOut(e, "HClusterCommand", "getRequiredFiles");
  59                 exit(1);
  60         }
  61 }
  62 //**********************************************************************************************************************
  63 //This function checks to make sure the cluster command has no errors and then clusters based on the method chosen.
  64 HClusterCommand::HClusterCommand(string option)  {
  65         try{
  66                 globaldata = GlobalData::getInstance();
  67                 abort = false;
  68
  69                 //allow user to run help
  70                 if(option == "help") { help(); abort = true; }
  71
  72                 else {
  73                         //valid paramters for this command
  74                         string Array[] =  {"cutoff","hard","precision","method","phylip","column","name","sorted","showabund","timing","outputdir","inputdir"};
  75                         vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  76
  77                         OptionParser parser(option);
  78                         map<string,string> parameters = parser.getParameters();
  79
  80                         ValidParameters validParameter;
  81                         map<string,string>::iterator it;
  82
  83                         //check to make sure all parameters are valid for command
  84                         for (it = parameters.begin(); it != parameters.end(); it++) {
  85                                 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {
  86                                         abort = true;
  87                                 }
  88                         }
  89
  90                         //initialize outputTypes
  91                         vector<string> tempOutNames;
  92                         outputTypes["list"] = tempOutNames;
  93                         outputTypes["rabund"] = tempOutNames;
  94                         outputTypes["sabund"] = tempOutNames;
  95
  96                         globaldata->newRead();
  97
  98                         //if the user changes the input directory command factory will send this info to us in the output parameter
  99                         string inputDir = validParameter.validFile(parameters, "inputdir", false);
 100                         if (inputDir == "not found"){   inputDir = "";          }
 101                         else {
 102                                 string path;
 103                                 it = parameters.find("phylip");
 104                                 //user has given a template file
 105                                 if(it != parameters.end()){
 106                                         path = m->hasPath(it->second);
 107                                         //if the user has not given a path then, add inputdir. else leave path alone.
 108                                         if (path == "") {       parameters["phylip"] = inputDir + it->second;           }
 109                                 }
 110
 111                                 it = parameters.find("column");
 112                                 //user has given a template file
 113                                 if(it != parameters.end()){
 114                                         path = m->hasPath(it->second);
 115                                         //if the user has not given a path then, add inputdir. else leave path alone.
 116                                         if (path == "") {       parameters["column"] = inputDir + it->second;           }
 117                                 }
 118
 119                                 it = parameters.find("name");
 120                                 //user has given a template file
 121                                 if(it != parameters.end()){
 122                                         path = m->hasPath(it->second);
 123                                         //if the user has not given a path then, add inputdir. else leave path alone.
 124                                         if (path == "") {       parameters["name"] = inputDir + it->second;             }
 125                                 }
 126                         }
 127
 128                         //if the user changes the output directory command factory will send this info to us in the output parameter
 129                         outputDir = validParameter.validFile(parameters, "outputdir", false);           if (outputDir == "not found"){  outputDir = "";         }
 130
 131                         //check for required parameters
 132                         phylipfile = validParameter.validFile(parameters, "phylip", true);
 133                         if (phylipfile == "not open") { abort = true; }
 134                         else if (phylipfile == "not found") { phylipfile = ""; }
 135                         else {  distfile = phylipfile;  format = "phylip";      }
 136
 137                         columnfile = validParameter.validFile(parameters, "column", true);
 138                         if (columnfile == "not open") { abort = true; }
 139                         else if (columnfile == "not found") { columnfile = ""; }
 140                         else {  distfile = columnfile; format = "column";       }
 141
 142                         namefile = validParameter.validFile(parameters, "name", true);
 143                         if (namefile == "not open") { abort = true; }
 144                         else if (namefile == "not found") { namefile = ""; }
 145
 146                         if ((phylipfile == "") && (columnfile == "")) { m->mothurOut("When executing a hcluster command you must enter a phylip or a column."); m->mothurOutEndLine(); abort = true; }
 147                         else if ((phylipfile != "") && (columnfile != "")) { m->mothurOut("When executing a hcluster command you must enter ONLY ONE of the following: phylip or column."); m->mothurOutEndLine(); abort = true; }
 148
 149                         if (columnfile != "") {
 150                                 if (namefile == "") {  cout << "You need to provide a namefile if you are going to use the column format." << endl; abort = true; }
 151                         }
 152
 153                         //check for optional parameter and set defaults
 154                         // ...at some point should added some additional type checking...
 155                         //get user cutoff and precision or use defaults
 156                         string temp;
 157                         temp = validParameter.validFile(parameters, "precision", false);
 158                         if (temp == "not found") { temp = "100"; }
 159                         //saves precision legnth for formatting below
 160                         length = temp.length();
 161                         convert(temp, precision);
 162
 163                         temp = validParameter.validFile(parameters, "hard", false);                     if (temp == "not found") { temp = "F"; }
 164                         hard = m->isTrue(temp);
 165
 166                         temp = validParameter.validFile(parameters, "cutoff", false);
 167                         if (temp == "not found") { temp = "10"; }
 168                         convert(temp, cutoff);
 169                         cutoff += (5 / (precision * 10.0));
 170
 171                         method = validParameter.validFile(parameters, "method", false);
 172                         if (method == "not found") { method = "furthest"; }
 173
 174                         if ((method == "furthest") || (method == "nearest") || (method == "average") || (method == "weighted")) { }
 175                         else { m->mothurOut("Not a valid clustering method.  Valid clustering algorithms are furthest, nearest, average or weighted."); m->mothurOutEndLine(); abort = true; }
 176
 177                         showabund = validParameter.validFile(parameters, "showabund", false);
 178                         if (showabund == "not found") { showabund = "T"; }
 179
 180                         sort = validParameter.validFile(parameters, "sorted", false);
 181                         if (sort == "not found") { sort = "F"; }
 182                         sorted = m->isTrue(sort);
 183
 184                         timing = validParameter.validFile(parameters, "timing", false);
 185                         if (timing == "not found") { timing = "F"; }
 186
 187
 188                         if (abort == false) {
 189
 190                                 if (outputDir == "") {  outputDir += m->hasPath(distfile); }
 191                                 fileroot = outputDir + m->getRootName(m->getSimpleName(distfile));
 192
 193                                 if (method == "furthest")               { tag = "fn";  }
 194                                 else if (method == "nearest")   { tag = "nn";  }
 195                                 else if (method == "weighted")  { tag = "wn";  }
 196                                 else                                                    { tag = "an";  }
 197
 198                                 m->openOutputFile(fileroot+ tag + ".sabund",    sabundFile);
 199                                 m->openOutputFile(fileroot+ tag + ".rabund",    rabundFile);
 200                                 m->openOutputFile(fileroot+ tag + ".list",              listFile);
 201
 202                                 outputNames.push_back(fileroot+ tag + ".sabund"); outputTypes["sabund"].push_back(fileroot+ tag + ".sabund");
 203                                 outputNames.push_back(fileroot+ tag + ".rabund"); outputTypes["rabund"].push_back(fileroot+ tag + ".rabund");
 204                                 outputNames.push_back(fileroot+ tag + ".list"); outputTypes["list"].push_back(fileroot+ tag + ".list");
 205                         }
 206                 }
 207         }
 208         catch(exception& e) {
 209                 m->errorOut(e, "HClusterCommand", "HClusterCommand");
 210                 exit(1);
 211         }
 212 }
 213
 214 //**********************************************************************************************************************
 215
 216 void HClusterCommand::help(){
 217         try {
 218                 m->mothurOut("The hcluster command parameter options are cutoff, precision, method, phylip, column, name, showabund, timing and sorted. Phylip or column and name are required.\n");
 219                 m->mothurOut("The phylip and column parameter allow you to enter your distance file, and sorted indicates whether your column distance file is already sorted. \n");
 220                 m->mothurOut("The name parameter allows you to enter your name file and is required if your distance file is in column format. \n");
 221                 m->mothurOut("The hcluster command should be in the following format: \n");
 222                 m->mothurOut("hcluster(column=youDistanceFile, name=yourNameFile, method=yourMethod, cutoff=yourCutoff, precision=yourPrecision) \n");
 223                 m->mothurOut("The acceptable hcluster methods are furthest, nearest, weighted and average.\n\n");
 224         }
 225         catch(exception& e) {
 226                 m->errorOut(e, "HClusterCommand", "help");
 227                 exit(1);
 228         }
 229 }
 230
 231 //**********************************************************************************************************************
 232
 233 HClusterCommand::~HClusterCommand(){}
 234
 235 //**********************************************************************************************************************
 236
 237 int HClusterCommand::execute(){
 238         try {
 239
 240                 if (abort == true) {    return 0;       }
 241
 242                 if(namefile != ""){
 243                         globaldata->nameMap = new NameAssignment(namefile);
 244                         globaldata->nameMap->readMap();
 245                 }else{
 246                         globaldata->nameMap = NULL;
 247                 }
 248
 249                 time_t estart = time(NULL);
 250
 251                 if (!sorted) {
 252                         read = new ReadCluster(distfile, cutoff, outputDir, true);
 253                         read->setFormat(format);
 254                         read->read(globaldata->nameMap);
 255
 256                         if (m->control_pressed) {
 257                                 delete read;
 258                                 sabundFile.close();
 259                                 rabundFile.close();
 260                                 listFile.close();
 261                                 for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 262                                 return 0;
 263                         }
 264
 265                         distfile = read->getOutputFile();
 266
 267                         list = read->getListVector();
 268                         delete read;
 269                 }else {
 270                         list = new ListVector(globaldata->nameMap->getListVector());
 271                 }
 272
 273                 if (m->control_pressed) {
 274                         sabundFile.close();
 275                         rabundFile.close();
 276                         listFile.close();
 277                         for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 278                         return 0;
 279                 }
 280
 281                 m->mothurOut("It took " + toString(time(NULL) - estart) + " seconds to sort. "); m->mothurOutEndLine();
 282                 estart = time(NULL);
 283
 284                 //list vector made by read contains all sequence names
 285                 if(list != NULL){
 286                         rabund = new RAbundVector(list->getRAbundVector());
 287                 }else{
 288                         m->mothurOut("Error: no list vector!"); m->mothurOutEndLine(); return 0;
 289                 }
 290
 291                 float previousDist = 0.00000;
 292                 float rndPreviousDist = 0.00000;
 293                 oldRAbund = *rabund;
 294                 oldList = *list;
 295
 296                 print_start = true;
 297                 start = time(NULL);
 298
 299                 cluster = new HCluster(rabund, list, method, distfile, globaldata->nameMap, cutoff);
 300                 vector<seqDist> seqs; seqs.resize(1); // to start loop
 301
 302                 if (m->control_pressed) {
 303                                 delete cluster;
 304                                 sabundFile.close();
 305                                 rabundFile.close();
 306                                 listFile.close();
 307                                 for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 308                                 return 0;
 309                 }
 310
 311
 312                 while (seqs.size() != 0){
 313
 314                         seqs = cluster->getSeqs();
 315
 316                         if (m->control_pressed) {
 317                                 delete cluster;
 318                                 sabundFile.close();
 319                                 rabundFile.close();
 320                                 listFile.close();
 321                                 for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 322                                 return 0;
 323                         }
 324
 325                         for (int i = 0; i < seqs.size(); i++) {  //-1 means skip me
 326
 327                                 if (seqs[i].seq1 != seqs[i].seq2) {
 328                                         cluster->update(seqs[i].seq1, seqs[i].seq2, seqs[i].dist);
 329
 330                                         if (m->control_pressed) {
 331                                                 delete cluster;
 332                                                 sabundFile.close();
 333                                                 rabundFile.close();
 334                                                 listFile.close();
 335                                                 for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 336                                                 return 0;
 337                                         }
 338
 339
 340                                         float rndDist;
 341                                         if (hard) {
 342                                                 rndDist = m->ceilDist(seqs[i].dist, precision);
 343                                         }else{
 344                                                 rndDist = m->roundDist(seqs[i].dist, precision);
 345                                         }
 346
 347
 348                                         if((previousDist <= 0.0000) && (seqs[i].dist != previousDist)){
 349                                                 printData("unique");
 350                                         }
 351                                         else if((rndDist != rndPreviousDist)){
 352                                                 printData(toString(rndPreviousDist,  length-1));
 353                                         }
 354
 355                                         previousDist = seqs[i].dist;
 356                                         rndPreviousDist = rndDist;
 357                                         oldRAbund = *rabund;
 358                                         oldList = *list;
 359                                 }
 360                         }
 361                 }
 362
 363                 if (m->control_pressed) {
 364                         delete cluster;
 365                         sabundFile.close();
 366                         rabundFile.close();
 367                         listFile.close();
 368                         for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 369                         return 0;
 370                 }
 371
 372                 if(previousDist <= 0.0000){
 373                         printData("unique");
 374                 }
 375                 else if(rndPreviousDist<cutoff){
 376                         printData(toString(rndPreviousDist, length-1));
 377                 }
 378
 379                 //delete globaldata's copy of the sparsematrix and listvector to free up memory
 380                 delete globaldata->gListVector;  globaldata->gListVector = NULL;
 381
 382                 //saves .list file so you can do the collect, rarefaction and summary commands without doing a read.list
 383                 if (globaldata->getFormat() == "phylip") { globaldata->setPhylipFile(""); }
 384                 else if (globaldata->getFormat() == "column") { globaldata->setColumnFile(""); }
 385
 386                 globaldata->setListFile(fileroot+ tag + ".list");
 387                 globaldata->setNameFile("");
 388                 globaldata->setFormat("list");
 389
 390                 sabundFile.close();
 391                 rabundFile.close();
 392                 listFile.close();
 393                 delete cluster;
 394
 395                 if (m->control_pressed) {
 396                         for (int i = 0; i < outputNames.size(); i++) {  remove(outputNames[i].c_str());  } outputTypes.clear();
 397                         return 0;
 398                 }
 399
 400
 401                 m->mothurOutEndLine();
 402                 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
 403                 for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
 404                 m->mothurOutEndLine();
 405
 406                 m->mothurOut("It took " + toString(time(NULL) - estart) + " seconds to cluster. "); m->mothurOutEndLine();
 407
 408                 return 0;
 409         }
 410         catch(exception& e) {
 411                 m->errorOut(e, "HClusterCommand", "execute");
 412                 exit(1);
 413         }
 414 }
 415
 416 //**********************************************************************************************************************
 417
 418 void HClusterCommand::printData(string label){
 419         try {
 420                 if (m->isTrue(timing)) {
 421                         m->mothurOut("\tTime: " + toString(time(NULL) - start) + "\tsecs for " + toString(oldRAbund.getNumBins())
 422                      + "\tclusters. Updates: " + toString(loops)); m->mothurOutEndLine();
 423                 }
 424                 print_start = true;
 425                 loops = 0;
 426                 start = time(NULL);
 427
 428                 oldRAbund.setLabel(label);
 429                 if (m->isTrue(showabund)) {
 430                         oldRAbund.getSAbundVector().print(cout);
 431                 }
 432                 oldRAbund.print(rabundFile);
 433                 oldRAbund.getSAbundVector().print(sabundFile);
 434
 435                 oldList.setLabel(label);
 436                 oldList.print(listFile);
 437         }
 438         catch(exception& e) {
 439                 m->errorOut(e, "HClusterCommand", "printData");
 440                 exit(1);
 441         }
 442
 443
 444 }
 445 //**********************************************************************************************************************
 446