errorchecking.cpp

   1 /*
   2  *  errorchecking.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 "errorchecking.h"
  11
  12 /*******************************************************/
  13
  14 /******************************************************/
  15
  16 ErrorCheck::ErrorCheck() {
  17         globaldata = GlobalData::getInstance();
  18         validCommand = new ValidCommands();
  19         validParameter = new ValidParameters();
  20 }
  21 /*******************************************************/
  22
  23 /******************************************************/
  24
  25 void ErrorCheck::refresh() {
  26         columnfile = globaldata->getColumnFile();
  27         phylipfile = globaldata->getPhylipFile();
  28         listfile = globaldata->getListFile();
  29         rabundfile = globaldata->getRabundFile();
  30         sabundfile = globaldata->getSabundFile();
  31         namefile = globaldata->getNameFile();
  32         groupfile = globaldata->getGroupFile();
  33         orderfile = globaldata->getOrderFile();
  34         fastafile = globaldata->getFastaFile();
  35         treefile = globaldata->getTreeFile();
  36         cutoff = globaldata->getCutOff();
  37         format = globaldata->getFormat();
  38         method = globaldata->getMethod();
  39         randomtree = globaldata->getRandomTree();
  40         sharedfile = globaldata->getSharedFile();
  41 }
  42
  43 /*******************************************************/
  44
  45 /******************************************************/
  46
  47 ErrorCheck::~ErrorCheck() {
  48         delete validCommand;
  49         delete validParameter;
  50 }
  51
  52 /*******************************************************/
  53
  54 /******************************************************/
  55
  56 bool ErrorCheck::checkInput(string input) {
  57                 errorFree = true;
  58                 clear();
  59
  60                 //refresh variable
  61                 refresh();
  62
  63                 //get command name and parameters
  64                 int openParen = input.find_first_of('(');
  65                 int closeParen = input.find_last_of(')');
  66
  67                 if(openParen != -1 && closeParen != -1){
  68                         commandName = input.substr(0, openParen);   //commandName contains everything before "("
  69                         optionText = input.substr(openParen+1, closeParen-openParen-1); //optionString contains everything between "(" and ")".
  70                 }else if (openParen == -1) { //there is no parenthesis
  71                         cout << input << " is not a valid command. You are missing the ()." << endl;
  72                         return false;
  73                 }
  74
  75                 //is it a valid command
  76                 if (validCommand->isValidCommand(commandName) != true) { return false; }
  77
  78                 string parameter, value;
  79
  80                 //reads in parameters and values
  81                 if((optionText != "") && (commandName != "help")){
  82                         while((optionText.find_first_of(',') != -1) && (errorFree)) {  //while there are parameters
  83                                 splitAtComma(value, optionText);
  84                                 splitAtEquals(parameter, value);
  85
  86                                 //is it a valid parameter
  87                                 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
  88
  89
  90
  91                                 if (parameter == "phylip" )             { phylipfile = value; }
  92                                 if (parameter == "column" )             { columnfile = value; }
  93                                 if (parameter == "list" )               { listfile = value; }
  94                                 if (parameter == "rabund" )             { rabundfile = value; }
  95                                 if (parameter == "sabund" )             { sabundfile = value; }
  96                                 if (parameter == "name" )               { namefile = value; }
  97                                 if (parameter == "order" )              { orderfile = value; }
  98                                 if (parameter == "fasta" )              { fastafile = value; }
  99                                 if (parameter == "tree" )               { treefile = value; }
 100                                 if (parameter == "group" )              { groupfile = value; }
 101                                 if (parameter == "shared" )             { sharedfile = value; }
 102                                 if (parameter == "cutoff" )                     { cutoff = value; }
 103                                 if (parameter == "precision" )          { precision = value; }
 104                                 if (parameter == "iters" )                      { iters = value; }
 105                                 if (parameter == "jumble" )                     { jumble = value; }
 106                                 if (parameter == "freq" )                       { freq = value; }
 107                                 if (parameter == "method" )                     { method = value; }
 108                                 if (parameter == "fileroot" )           { fileroot = value; }
 109                                 if (parameter == "line" )                       { line = value; }
 110                                 if (parameter == "label" )                      { label = value; }
 111                                 if (parameter == "abund" )          { abund = value; }
 112                                 if (parameter == "random" )                     { randomtree = value;   }
 113                                 if (parameter == "sorted" )                     { sorted = value;       }
 114                         }
 115
 116                         //gets the last parameter and value
 117                         if (errorFree)  { //gets the last parameter and value
 118                                 value = optionText;
 119                                 splitAtEquals(parameter, value);
 120                                 //is it a valid parameter
 121                                 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
 122
 123
 124                                 if (parameter == "phylip" )             { phylipfile = value; }
 125                                 if (parameter == "column" )             { columnfile = value; }
 126                                 if (parameter == "list" )               { listfile = value; }
 127                                 if (parameter == "rabund" )             { rabundfile = value; }
 128                                 if (parameter == "sabund" )             { sabundfile = value; }
 129                                 if (parameter == "name" )               { namefile = value; }
 130                                 if (parameter == "order" )              { orderfile = value; }
 131                                 if (parameter == "group" )              { groupfile = value; }
 132                                 if (parameter == "shared" )             { sharedfile = value; }
 133                                 if (parameter == "fasta" )              { fastafile = value; }
 134                                 if (parameter == "tree" )               { treefile = value; }
 135                                 if (parameter == "cutoff" )                     { cutoff = value; }
 136                                 if (parameter == "precision" )          { precision = value; }
 137                                 if (parameter == "iters" )                      { iters = value; }
 138                                 if (parameter == "jumble" )                     { jumble = value; }
 139                                 if (parameter == "freq" )                       { freq = value; }
 140                                 if (parameter == "method" )                     { method = value; }
 141                                 if (parameter == "fileroot" )           { fileroot = value; }
 142                                 if (parameter == "line" )                       { line = value; }
 143                                 if (parameter == "label" )                      { label = value; }
 144                                 if (parameter == "random" )                     { randomtree = value;   }
 145                                 if (parameter == "abund" )          { abund = value; }
 146                                 if (parameter == "sorted" )                     { sorted = value;       }
 147                         }
 148                 }
 149
 150                 //make sure the user does not use both the line and label parameters
 151                 if ((line != "") && (label != "")) { cout << "You may use either the line or label parameters, but not both." << endl; return false; }
 152
 153                 //check for valid files
 154                 if (commandName == "read.dist") {
 155                         validateReadFiles();
 156                         validateReadDist();
 157                 }else if (commandName == "read.otu") {
 158                         //you want to do shared commands
 159                         if ((listfile != "") && (groupfile != ""))      {
 160                                 validateParseFiles(); //checks the listfile and groupfile parameters
 161                         //you want to do single commands
 162                         }else if ((listfile != "") || (rabundfile != "") || (sabundfile != "")){
 163                                 validateReadFiles();
 164                                 validateReadPhil();
 165                         //you have not given a file
 166                         }else if ((listfile == "") && (sharedfile == "") && (rabundfile == "") && (sabundfile == "")) {
 167                                 cout << "You must enter either a listfile, rabundfile, sabundfile or a sharedfile with the read.otu command. " << endl; return false;
 168                         //you want to do shared commands with a shared file
 169                         }else if (sharedfile != "") {//you are reading a shared file
 170                                 validateReadFiles();
 171                         }
 172                 }else if (commandName == "read.tree") {
 173                         validateTreeFiles(); //checks the treefile and groupfile parameters
 174                 }else if (commandName == "deconvolute") {
 175                         if (fastafile == "") { cout << "You must enter a fastafile with the deconvolute() command." << endl; return false; }
 176                         validateReadFiles();
 177                 }
 178
 179                 //are you trying to cluster before you have read something
 180                 if (((commandName == "cluster") && (globaldata->gSparseMatrix == NULL)) ||
 181                         ((commandName == "cluster") && (globaldata->gListVector == NULL))) {
 182                                 cout << "Before you use the cluster command, you first need to read in a distance matrix." << endl;
 183                                 errorFree = false;
 184                 }
 185
 186                 if ((commandName == "libshuff") && ((globaldata->gMatrix == NULL) || (globaldata->gGroupmap == NULL))) {
 187                          cout << "You must read in a matrix and groupfile using the read.dist command, before you use the libshuff command. " << endl; return false;
 188                 }
 189
 190                 if (commandName == "parsimony") {
 191                         //are you trying to use parsimony without reading a tree or saying you want random distribution
 192                         if (randomtree == "")  {
 193                                 if (globaldata->gTree.size() == 0) {
 194                                         cout << "You must read a treefile and a groupfile or set the randomtree parameter to the output filename you wish, before you may execute the parsimony command." << endl; return false;  }
 195                         }
 196                 }
 197
 198                 if ((commandName == "unifrac.weighted") || (commandName == "unifrac.unweighted")) {
 199                         if (globaldata->gTree.size() == 0) {//no trees were read
 200                                 cout << "You must execute the read.tree command, before you may execute the unifrac.weighted or unifrac.unweighted command." << endl; return false;  }
 201                 }
 202
 203                 //check for valid method
 204                 if(commandName == "get.group") {
 205                         if ((globaldata->getGroupFile() == "")) { cout << "You must read a group before you can use the get.group command." << endl; return false; }
 206                 }
 207                 if (commandName == "get.label" || commandName == "get.line") {
 208                         if ((globaldata->getListFile() == "") && (globaldata->getRabundFile() == "") && (globaldata->getSabundFile() == "")) { cout << "You must read a list, sabund or rabund before you can use the get.label or get.line command." << endl; return false; }
 209                 }
 210                 if (commandName == "cluster") {
 211                         if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
 212                         else {cout << "Not a valid clustering method.  Valid clustering algorithms are furthest, nearest or average." << endl; return false; }
 213                 }
 214
 215                 if ((commandName == "collect.single") || (commandName == "rarefaction.single") || (commandName == "summary.single") ){
 216                         if ((globaldata->getListFile() == "") && (globaldata->getRabundFile() == "") && (globaldata->getSabundFile() == "")) { cout << "You must read a list, sabund or rabund before you can use the collect.single, rarefaction.single or summary.single commands." << endl; return false; }
 217                 }
 218
 219                 if ((commandName == "collect.shared") || (commandName == "rarefaction.shared") || (commandName == "summary.shared") ){
 220                         if (globaldata->getSharedFile() == "") {
 221                                 if (globaldata->getListFile() == "") { cout << "You must read a list and a group, or a shared before you can use the collect.shared, rarefaction.shared or summary.shared commands." << endl; return false; }
 222                                 else if (globaldata->getGroupFile() == "") { cout << "You must read a list and a group, or a shared before you can use the collect.shared, rarefaction.shared or summary.shared commands." << endl; return false; }
 223                         }
 224                 }
 225
 226                 if ((commandName == "heatmap") || (commandName == "venn")) {
 227                         if ((globaldata->getListFile() == "") && (globaldata->getSharedFile() == "")) {
 228                                  cout << "You must read a list, or a list and a group, or a shared before you can use the heatmap or venn commands." << endl; return false;
 229                         }
 230                 }
 231
 232                 if ((commandName == "bin.seqs")) {
 233                         if ((globaldata->getListFile() == "")) { cout << "You must read a list file before you can use the bin.seqs command." << endl; return false; }
 234                         validateBinFiles();
 235                 }
 236
 237                 return errorFree;
 238 }
 239
 240 /*******************************************************/
 241
 242 /******************************************************/
 243 //This function checks to make sure the user entered a file to
 244 // read and that the file exists and can be opened.
 245 void ErrorCheck::validateReadFiles() {
 246         try {
 247                 //Validating files for read
 248                 ifstream filehandle;
 249                 int ableToOpen;
 250
 251                 //are we reading a phylipfile
 252                 if (phylipfile != "") {
 253                         ableToOpen = openInputFile(phylipfile, filehandle);
 254                         filehandle.close();
 255                         //unable to open
 256                         if (ableToOpen == 1) { errorFree = false; }
 257                         else { globaldata->inputFileName = phylipfile; }
 258                 //are we reading a columnfile
 259                 }else if (columnfile != "") {
 260                         ableToOpen = openInputFile(columnfile, filehandle);
 261                         filehandle.close();
 262                         //unable to open
 263                         if (ableToOpen == 1) { errorFree = false; }
 264                         else { globaldata->inputFileName = columnfile; }
 265                 //are we reading a listfile
 266                 }else if (listfile!= "") {
 267                         ableToOpen = openInputFile(listfile, filehandle);
 268                         filehandle.close();
 269                         //unable to open
 270                         if (ableToOpen == 1) {  errorFree = false; }
 271                         else { globaldata->inputFileName = listfile; }
 272                 //are we reading a rabundfile
 273                 }else if (rabundfile != "") {
 274                         ableToOpen = openInputFile(rabundfile, filehandle);
 275                         filehandle.close();
 276                         //unable to open
 277                         if (ableToOpen == 1) {  errorFree = false; }
 278                         else { globaldata->inputFileName = rabundfile; }
 279                 //are we reading a sabundfile
 280                 }else if (sabundfile != "") {
 281                         ableToOpen = openInputFile(sabundfile, filehandle);
 282                         filehandle.close();
 283                         //unable to open
 284                         if (ableToOpen == 1) {  errorFree = false; }
 285                         else { globaldata->inputFileName = sabundfile; }
 286                 }else if (fastafile != "") {
 287                         ableToOpen = openInputFile(fastafile, filehandle);
 288                         filehandle.close();
 289                         //unable to open
 290                         if (ableToOpen == 1) {  errorFree = false; }
 291                         else { globaldata->inputFileName = fastafile; }
 292                 }else if (sharedfile != "") {
 293                         ableToOpen = openInputFile(sharedfile, filehandle);
 294                         filehandle.close();
 295                         //unable to open
 296                         if (ableToOpen == 1) {  errorFree = false; }
 297                         else { globaldata->inputFileName = sharedfile; }
 298                 }else{ //no file given
 299                         errorFree = false;
 300                 }
 301         }
 302         catch(exception& e) {
 303                 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 304                 exit(1);
 305         }
 306         catch(...) {
 307                 cout << "An unknown error has occurred in the ErrorCheck class function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 308                 exit(1);
 309         }
 310
 311 }
 312 /*******************************************************/
 313
 314 /******************************************************/
 315 //This function checks to make sure the user entered appropriate
 316 // format parameters on a distfile read
 317 void ErrorCheck::validateReadDist() {
 318         try {
 319                 ifstream filehandle;
 320                 int ableToOpen;
 321
 322                 if (groupfile != "") {
 323                         ableToOpen = openInputFile(groupfile, filehandle);
 324                         filehandle.close();
 325                         //unable to open
 326                         if (ableToOpen == 1) {  errorFree = false; }
 327                 }
 328
 329                 if ((phylipfile == "") && (columnfile == "")) { cout << "When executing a read.dist you must enter a phylip or a column." << endl; errorFree = false; }
 330                 else if ((phylipfile != "") && (columnfile != "")) { cout << "When executing a read.dist you must enter ONLY ONE of the following: phylip or column." << endl; errorFree = false; }
 331
 332                 if (columnfile != "") {
 333                         if (namefile == "") {
 334                                 cout << "You need to provide a namefile if you are going to use the column format." << endl;
 335                                 errorFree = false;
 336                         }else {
 337                                 ableToOpen = openInputFile(namefile, filehandle);
 338                                 filehandle.close();
 339                                 //unable to open
 340                                 if (ableToOpen == 1) { errorFree = false; }
 341                         }
 342                 }
 343         }
 344         catch(exception& e) {
 345                 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 346                 exit(1);
 347         }
 348         catch(...) {
 349                 cout << "An unknown error has occurred in the ErrorCheck class function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 350                 exit(1);
 351         }
 352 }
 353 /*******************************************************/
 354
 355 /******************************************************/
 356 //This function checks to make sure the user entered appropriate
 357 // format parameters on a parselistcommand
 358 void ErrorCheck::validateParseFiles() {
 359         try {
 360                 ifstream filehandle;
 361                 int ableToOpen;
 362
 363                 //checks for valid files
 364
 365                 if (listfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
 366                 else if (groupfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
 367
 368                 //checks parameters on the read command
 369                 if (listfile != "") {
 370                         ableToOpen = openInputFile(listfile, filehandle);
 371                         filehandle.close();
 372                         if (ableToOpen == 1) { //unable to open
 373                                 errorFree = false;
 374                         }
 375                         if (groupfile != "") {
 376                                 ableToOpen = openInputFile(groupfile, filehandle);
 377                                 filehandle.close();
 378                                 if (ableToOpen == 1) { //unable to open
 379                                         errorFree = false;;
 380                                 }
 381                         }
 382                 }
 383         }
 384         catch(exception& e) {
 385                 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 386                 exit(1);
 387         }
 388         catch(...) {
 389                 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 390                 exit(1);
 391         }
 392 }
 393 /*******************************************************/
 394
 395 /******************************************************/
 396 //This function checks to make sure the user entered appropriate
 397 // format parameters on a parselistcommand
 398 void ErrorCheck::validateTreeFiles() {
 399         try {
 400                 ifstream filehandle;
 401                 int ableToOpen;
 402
 403                 //checks for valid files
 404
 405                 if (treefile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
 406                 else if (groupfile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
 407
 408                 //checks parameters on the read command
 409                 if (treefile != "") {
 410                         ableToOpen = openInputFile(treefile, filehandle);
 411                         filehandle.close();
 412                         if (ableToOpen == 1) { //unable to open
 413                                 errorFree = false;
 414                         }
 415                         if (groupfile != "") {
 416                                 ableToOpen = openInputFile(groupfile, filehandle);
 417                                 filehandle.close();
 418                                 if (ableToOpen == 1) { //unable to open
 419                                         errorFree = false;;
 420                                 }
 421                         }
 422                 }
 423         }
 424         catch(exception& e) {
 425                 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 426                 exit(1);
 427         }
 428         catch(...) {
 429                 cout << "An unknown error has occurred in the ErrorCheck class function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 430                 exit(1);
 431         }
 432 }
 433
 434 /*******************************************************/
 435
 436 /******************************************************/
 437 //This function checks to make sure the user entered appropriate
 438 // format parameters on a distfile read
 439 void ErrorCheck::validateReadPhil() {
 440         try {
 441                 ifstream filehandle;
 442                 int ableToOpen;
 443
 444                 //checks to make sure only one file type is given
 445                 if (listfile != "") {
 446                         if ((rabundfile != "") || (sabundfile != "")) {
 447                                 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
 448                 }else if (rabundfile != "") {
 449                         if ((listfile != "") || (sabundfile != "")) {
 450                                 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
 451                 }else if (sabundfile != "") {
 452                         if ((listfile != "") || (rabundfile != "")) {
 453                                 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
 454                 }else if ((listfile == "") && (rabundfile == "") && (sabundfile == "") && (sharedfile == "")) {
 455                             cout << "When executing a read.otu you must enter one of the following: list, rabund or sabund." << endl; errorFree = false;
 456                 }
 457
 458                 //checks parameters on the read command
 459                 if (orderfile != "") {
 460                         ableToOpen = openInputFile(orderfile, filehandle);
 461                         filehandle.close();
 462                         if (ableToOpen == 1) { //unable to open
 463                                 errorFree = false;
 464                         }
 465                 }
 466         }
 467         catch(exception& e) {
 468                 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 469                 exit(1);
 470         }
 471         catch(...) {
 472                 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 473                 exit(1);
 474         }
 475 }
 476 /*******************************************************/
 477
 478 /******************************************************/
 479 //This function checks to make sure the user entered appropriate
 480 // format parameters on a bin.seq command
 481 void ErrorCheck::validateBinFiles() {
 482         try {
 483                 ifstream filehandle;
 484                 int ableToOpen;
 485
 486                 if (fastafile == "") {
 487                                 cout << "fasta is a required parameter for bin.seqs." << endl; errorFree = false;
 488                 }else if (fastafile != "") {
 489                         //is it a valid filename'
 490                         ableToOpen = openInputFile(fastafile, filehandle);
 491                         filehandle.close();
 492                         //unable to open
 493                         if (ableToOpen == 1) {  errorFree = false; }
 494                 }else if (globaldata->getNameFile() != "") {
 495                         //is it a valid filename'
 496                         ifstream filehandle;
 497                         int ableToOpen = openInputFile(globaldata->getNameFile(), filehandle);
 498                         filehandle.close();
 499                         //unable to open
 500                         if (ableToOpen == 1) {  errorFree = false; }
 501                 }else if (namefile != "") {
 502                         //is it a valid filename'
 503                         ifstream filehandle;
 504                         int ableToOpen = openInputFile(namefile, filehandle);
 505                         filehandle.close();
 506                         //unable to open
 507                         if (ableToOpen == 1) {  errorFree = false; }
 508                 }
 509
 510
 511         }
 512         catch(exception& e) {
 513                 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 514                 exit(1);
 515         }
 516         catch(...) {
 517                 cout << "An unknown error has occurred in the ErrorCheck class function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
 518                 exit(1);
 519         }
 520 }
 521
 522 /*******************************************************/
 523
 524 /******************************************************/
 525
 526 void ErrorCheck::clear() {
 527         //option definitions should go here...
 528         phylipfile              =       "";
 529         columnfile              =       "";
 530         listfile                =       "";
 531         rabundfile              =       "";
 532         sabundfile              =       "";
 533         namefile                =       "";
 534         groupfile               =       "";
 535         orderfile               =       "";
 536         sharedfile              =       "";
 537         line                    =       "";
 538         label                   =       "";
 539         method                  =   "furthest";
 540 }
 541 /*******************************************************/
 542
 543 /******************************************************/
 544