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 //This function checks to make sure the cluster command has no errors and then clusters based on the method chosen.
  14 HClusterCommand::HClusterCommand(string option){
  15         try{
  16                 globaldata = GlobalData::getInstance();
  17                 abort = false;
  18
  19                 //allow user to run help
  20                 if(option == "help") { help(); abort = true; }
  21
  22                 else {
  23                         //valid paramters for this command
  24                         string Array[] =  {"cutoff","precision","method","phylip","column","name","sorted","showabund","timing","outputdir","inputdir"};
  25                         vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
  26
  27                         OptionParser parser(option);
  28                         map<string,string> parameters = parser.getParameters();
  29
  30                         ValidParameters validParameter;
  31                         map<string,string>::iterator it;
  32
  33                         //check to make sure all parameters are valid for command
  34                         for (it = parameters.begin(); it != parameters.end(); it++) {
  35                                 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {
  36                                         abort = true;
  37                                 }
  38                         }
  39
  40                         globaldata->newRead();
  41
  42                         //if the user changes the input directory command factory will send this info to us in the output parameter
  43                         string inputDir = validParameter.validFile(parameters, "inputdir", false);
  44                         if (inputDir == "not found"){   inputDir = "";          }
  45                         else {
  46                                 string path;
  47                                 it = parameters.find("phylip");
  48                                 //user has given a template file
  49                                 if(it != parameters.end()){
  50                                         path = hasPath(it->second);
  51                                         //if the user has not given a path then, add inputdir. else leave path alone.
  52                                         if (path == "") {       parameters["phylip"] = inputDir + it->second;           }
  53                                 }
  54
  55                                 it = parameters.find("column");
  56                                 //user has given a template file
  57                                 if(it != parameters.end()){
  58                                         path = hasPath(it->second);
  59                                         //if the user has not given a path then, add inputdir. else leave path alone.
  60                                         if (path == "") {       parameters["column"] = inputDir + it->second;           }
  61                                 }
  62
  63                                 it = parameters.find("name");
  64                                 //user has given a template file
  65                                 if(it != parameters.end()){
  66                                         path = hasPath(it->second);
  67                                         //if the user has not given a path then, add inputdir. else leave path alone.
  68                                         if (path == "") {       parameters["name"] = inputDir + it->second;             }
  69                                 }
  70                         }
  71
  72                         //if the user changes the output directory command factory will send this info to us in the output parameter
  73                         outputDir = validParameter.validFile(parameters, "outputdir", false);           if (outputDir == "not found"){  outputDir = "";         }
  74
  75                         //check for required parameters
  76                         phylipfile = validParameter.validFile(parameters, "phylip", true);
  77                         if (phylipfile == "not open") { abort = true; }
  78                         else if (phylipfile == "not found") { phylipfile = ""; }
  79                         else {  distfile = phylipfile;  format = "phylip";      }
  80
  81                         columnfile = validParameter.validFile(parameters, "column", true);
  82                         if (columnfile == "not open") { abort = true; }
  83                         else if (columnfile == "not found") { columnfile = ""; }
  84                         else {  distfile = columnfile; format = "column";       }
  85
  86                         namefile = validParameter.validFile(parameters, "name", true);
  87                         if (namefile == "not open") { abort = true; }
  88                         else if (namefile == "not found") { namefile = ""; }
  89
  90                         if ((phylipfile == "") && (columnfile == "")) { mothurOut("When executing a hcluster command you must enter a phylip or a column."); mothurOutEndLine(); abort = true; }
  91                         else if ((phylipfile != "") && (columnfile != "")) { mothurOut("When executing a hcluster command you must enter ONLY ONE of the following: phylip or column."); mothurOutEndLine(); abort = true; }
  92
  93                         if (columnfile != "") {
  94                                 if (namefile == "") {  cout << "You need to provide a namefile if you are going to use the column format." << endl; abort = true; }
  95                         }
  96
  97                         //check for optional parameter and set defaults
  98                         // ...at some point should added some additional type checking...
  99                         //get user cutoff and precision or use defaults
 100                         string temp;
 101                         temp = validParameter.validFile(parameters, "precision", false);
 102                         if (temp == "not found") { temp = "100"; }
 103                         //saves precision legnth for formatting below
 104                         length = temp.length();
 105                         convert(temp, precision);
 106
 107                         temp = validParameter.validFile(parameters, "cutoff", false);
 108                         if (temp == "not found") { temp = "10"; }
 109                         convert(temp, cutoff);
 110                         cutoff += (5 / (precision * 10.0));
 111
 112                         method = validParameter.validFile(parameters, "method", false);
 113                         if (method == "not found") { method = "furthest"; }
 114
 115                         if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
 116                         else { mothurOut("Not a valid clustering method.  Valid clustering algorithms are furthest, nearest or average."); mothurOutEndLine(); abort = true; }
 117
 118                         showabund = validParameter.validFile(parameters, "showabund", false);
 119                         if (showabund == "not found") { showabund = "T"; }
 120
 121                         sort = validParameter.validFile(parameters, "sorted", false);
 122                         if (sort == "not found") { sort = "F"; }
 123                         sorted = isTrue(sort);
 124
 125                         timing = validParameter.validFile(parameters, "timing", false);
 126                         if (timing == "not found") { timing = "F"; }
 127
 128
 129                         if (abort == false) {
 130
 131                                 if (outputDir == "") {  outputDir += hasPath(distfile); }
 132                                 fileroot = outputDir + getRootName(getSimpleName(distfile));
 133
 134                                 if (method == "furthest")               { tag = "fn";  }
 135                                 else if (method == "nearest")   { tag = "nn";  }
 136                                 else                                                    { tag = "an";  }
 137
 138                                 openOutputFile(fileroot+ tag + ".sabund",       sabundFile);
 139                                 openOutputFile(fileroot+ tag + ".rabund",       rabundFile);
 140                                 openOutputFile(fileroot+ tag + ".list",         listFile);
 141                         }
 142                 }
 143         }
 144         catch(exception& e) {
 145                 errorOut(e, "HClusterCommand", "HClusterCommand");
 146                 exit(1);
 147         }
 148 }
 149
 150 //**********************************************************************************************************************
 151
 152 void HClusterCommand::help(){
 153         try {
 154                 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");
 155                 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");
 156                 mothurOut("The name parameter allows you to enter your name file and is required if your distance file is in column format. \n");
 157                 mothurOut("The hcluster command should be in the following format: \n");
 158                 mothurOut("hcluster(column=youDistanceFile, name=yourNameFile, method=yourMethod, cutoff=yourCutoff, precision=yourPrecision) \n");
 159                 mothurOut("The acceptable hcluster methods are furthest and nearest, but we hope to add average in the future.\n\n");
 160         }
 161         catch(exception& e) {
 162                 errorOut(e, "HClusterCommand", "help");
 163                 exit(1);
 164         }
 165 }
 166
 167 //**********************************************************************************************************************
 168
 169 HClusterCommand::~HClusterCommand(){}
 170
 171 //**********************************************************************************************************************
 172
 173 int HClusterCommand::execute(){
 174         try {
 175
 176                 if (abort == true) {    return 0;       }
 177
 178                 if(namefile != ""){
 179                         globaldata->nameMap = new NameAssignment(namefile);
 180                         globaldata->nameMap->readMap();
 181                 }else{
 182                         globaldata->nameMap = NULL;
 183                 }
 184
 185                 time_t estart = time(NULL);
 186
 187                 if (!sorted) {
 188                         read = new ReadCluster(distfile, cutoff);
 189                         read->setFormat(format);
 190                         read->read(globaldata->nameMap);
 191                         distfile = read->getOutputFile();
 192
 193                         list = read->getListVector();
 194                         delete read;
 195                 }else {
 196                         list = new ListVector(globaldata->nameMap->getListVector());
 197                 }
 198
 199                 mothurOut("It took " + toString(time(NULL) - estart) + " seconds to sort. "); mothurOutEndLine();
 200                 estart = time(NULL);
 201
 202                 //list vector made by read contains all sequence names
 203                 if(list != NULL){
 204                         rabund = new RAbundVector(list->getRAbundVector());
 205                 }else{
 206                         mothurOut("Error: no list vector!"); mothurOutEndLine(); return 0;
 207                 }
 208
 209                 float previousDist = 0.00000;
 210                 float rndPreviousDist = 0.00000;
 211                 oldRAbund = *rabund;
 212                 oldList = *list;
 213
 214                 print_start = true;
 215                 start = time(NULL);
 216
 217                 cluster = new HCluster(rabund, list, method, distfile, globaldata->nameMap, cutoff);
 218                 vector<seqDist> seqs; seqs.resize(1); // to start loop
 219
 220                 while (seqs.size() != 0){
 221
 222                         seqs = cluster->getSeqs();
 223
 224                         for (int i = 0; i < seqs.size(); i++) {  //-1 means skip me
 225
 226                                 if (seqs[i].seq1 != seqs[i].seq2) {
 227                                         cluster->update(seqs[i].seq1, seqs[i].seq2, seqs[i].dist);
 228
 229                                         float rndDist = roundDist(seqs[i].dist, precision);
 230
 231                                         if((previousDist <= 0.0000) && (seqs[i].dist != previousDist)){
 232                                                 printData("unique");
 233                                         }
 234                                         else if((rndDist != rndPreviousDist)){
 235                                                 printData(toString(rndPreviousDist,  length-1));
 236                                         }
 237
 238                                         previousDist = seqs[i].dist;
 239                                         rndPreviousDist = rndDist;
 240                                         oldRAbund = *rabund;
 241                                         oldList = *list;
 242                                 }
 243                         }
 244                 }
 245
 246                 if(previousDist <= 0.0000){
 247                         printData("unique");
 248                 }
 249                 else if(rndPreviousDist<cutoff){
 250                         printData(toString(rndPreviousDist, length-1));
 251                 }
 252
 253                 //delete globaldata's copy of the sparsematrix and listvector to free up memory
 254                 delete globaldata->gListVector;  globaldata->gListVector = NULL;
 255
 256                 //saves .list file so you can do the collect, rarefaction and summary commands without doing a read.list
 257                 if (globaldata->getFormat() == "phylip") { globaldata->setPhylipFile(""); }
 258                 else if (globaldata->getFormat() == "column") { globaldata->setColumnFile(""); }
 259
 260                 globaldata->setListFile(fileroot+ tag + ".list");
 261                 globaldata->setNameFile("");
 262                 globaldata->setFormat("list");
 263
 264                 sabundFile.close();
 265                 rabundFile.close();
 266                 listFile.close();
 267                 delete cluster;
 268
 269                 mothurOut("It took " + toString(time(NULL) - estart) + " seconds to cluster. "); mothurOutEndLine();
 270
 271                 return 0;
 272         }
 273         catch(exception& e) {
 274                 errorOut(e, "HClusterCommand", "execute");
 275                 exit(1);
 276         }
 277 }
 278
 279 //**********************************************************************************************************************
 280
 281 void HClusterCommand::printData(string label){
 282         try {
 283                 if (isTrue(timing)) {
 284                         mothurOut("\tTime: " + toString(time(NULL) - start) + "\tsecs for " + toString(oldRAbund.getNumBins())
 285                      + "\tclusters. Updates: " + toString(loops)); mothurOutEndLine();
 286                 }
 287                 print_start = true;
 288                 loops = 0;
 289                 start = time(NULL);
 290
 291                 oldRAbund.setLabel(label);
 292                 if (isTrue(showabund)) {
 293                         oldRAbund.getSAbundVector().print(cout);
 294                 }
 295                 oldRAbund.print(rabundFile);
 296                 oldRAbund.getSAbundVector().print(sabundFile);
 297
 298                 oldList.setLabel(label);
 299                 oldList.print(listFile);
 300         }
 301         catch(exception& e) {
 302                 errorOut(e, "HClusterCommand", "printData");
 303                 exit(1);
 304         }
 305
 306
 307 }
 308 //**********************************************************************************************************************
 309