]> git.donarmstrong.com Git - mothur.git/blobdiff - errorchecking.cpp
fixed memory leak in parsimony calculator and added progress bars to parsimony and...
[mothur.git] / errorchecking.cpp
index 121a0120a17fb1410901a219a95d0361911d7187..da1d1bbb614ffd78f03484c3ca956e3f5aba21ac 100644 (file)
@@ -17,7 +17,12 @@ ErrorCheck::ErrorCheck() {
        globaldata = GlobalData::getInstance();
        validCommand = new ValidCommands();
        validParameter = new ValidParameters();
-       validCalculator = new ValidCalculators();
+}
+/*******************************************************/
+
+/******************************************************/
+
+void ErrorCheck::refresh() {
        columnfile = globaldata->getColumnFile();
        phylipfile = globaldata->getPhylipFile();
        listfile = globaldata->getListFile();
@@ -31,13 +36,18 @@ ErrorCheck::ErrorCheck() {
        cutoff = globaldata->getCutOff();
        format = globaldata->getFormat();
        method = globaldata->getMethod();
-
+       randomtree = globaldata->getRandomTree();
+       sharedfile = globaldata->getSharedFile();
 }
+
 /*******************************************************/
 
 /******************************************************/
 
-ErrorCheck::~ErrorCheck() {}
+ErrorCheck::~ErrorCheck() {
+       delete validCommand;
+       delete validParameter;
+}
 
 /*******************************************************/
 
@@ -46,7 +56,10 @@ ErrorCheck::~ErrorCheck() {}
 bool ErrorCheck::checkInput(string input) {
                errorFree = true;
                clear();
-
+               
+               //refresh variable
+               refresh();
+               
                //get command name and parameters
                int openParen = input.find_first_of('(');
                int closeParen = input.find_last_of(')');
@@ -63,25 +76,29 @@ bool ErrorCheck::checkInput(string input) {
                if (validCommand->isValidCommand(commandName) != true) { return false; }
                
                string parameter, value;
+               
                //reads in parameters and values
                if((optionText != "") && (commandName != "help")){
                        while((optionText.find_first_of(',') != -1) && (errorFree)) {  //while there are parameters
-                               globaldata->splitAtComma(value, optionText);
-                               globaldata->splitAtEquals(parameter, value);
+                               splitAtComma(value, optionText);
+                               splitAtEquals(parameter, value);
                                
                                //is it a valid parameter
-                               if (validParameter->isValidParameter(parameter) != true) { return false; }
+                               if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
+
+
                                
-                               if (parameter == "phylipfile" )         { phylipfile = value; }
-                               if (parameter == "columnfile" )         { columnfile = value; }
-                               if (parameter == "listfile" )           { listfile = value; }
-                               if (parameter == "rabundfile" )         { rabundfile = value; }
-                               if (parameter == "sabundfile" )         { sabundfile = value; }
-                               if (parameter == "namefile" )           { namefile = value; }
-                               if (parameter == "orderfile" )          { orderfile = value; }
-                               if (parameter == "fastafile" )          { fastafile = value; }
-                               if (parameter == "treefile" )           { treefile = value; }
-                               if (parameter == "groupfile" )          { groupfile = value; }
+                               if (parameter == "phylip" )             { phylipfile = value; }
+                               if (parameter == "column" )             { columnfile = value; }
+                               if (parameter == "list" )               { listfile = value; }
+                               if (parameter == "rabund" )             { rabundfile = value; }
+                               if (parameter == "sabund" )             { sabundfile = value; }
+                               if (parameter == "name" )               { namefile = value; }
+                               if (parameter == "order" )              { orderfile = value; }
+                               if (parameter == "fasta" )              { fastafile = value; }
+                               if (parameter == "tree" )               { treefile = value; }
+                               if (parameter == "group" )              { groupfile = value; }
+                               if (parameter == "shared" )             { sharedfile = value; }
                                if (parameter == "cutoff" )                     { cutoff = value; }
                                if (parameter == "precision" )          { precision = value; }
                                if (parameter == "iters" )                      { iters = value; }
@@ -91,66 +108,30 @@ bool ErrorCheck::checkInput(string input) {
                                if (parameter == "fileroot" )           { fileroot = value; }
                                if (parameter == "line" )                       { line = value; }
                                if (parameter == "label" )                      { label = value; }
-
-                               if (parameter == "single") {//stores estimators in a vector
-                                       singleEsimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, singleEsimators);
-                                       for (int i = 0; i < singleEsimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, singleEsimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "rarefaction") {//stores estimators in a vector
-                                       rareEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, rareEstimators);
-                                       for (int i = 0; i < rareEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, rareEstimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "shared") {//stores estimators in a vector
-                                       sharedEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, sharedEstimators);
-                                       for (int i = 0; i < sharedEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, sharedEstimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "summary") { //stores summaries to be used in a vector
-                                       summaryEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, summaryEstimators);
-                                       for (int i = 0; i < summaryEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, summaryEstimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "sharedrarefaction") { //stores summaries to be used in a vector
-                                       sharedRareEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, sharedRareEstimators);
-                                       for (int i = 0; i < sharedRareEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, sharedRareEstimators[i]) != true) { return false; }
-                                       }
-                               }
+                               if (parameter == "abund" )          { abund = value; }
+                               if (parameter == "random" )                     { randomtree = value;   }
+                               if (parameter == "sorted" )                     { sorted = value;       }
                        }
                        
                        //gets the last parameter and value
                        if (errorFree)  { //gets the last parameter and value
                                value = optionText;
-                               globaldata->splitAtEquals(parameter, value);
+                               splitAtEquals(parameter, value);
                                //is it a valid parameter
-                               if (validParameter->isValidParameter(parameter) != true) { return false; }
+                               if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
+       
                                
-                               if (parameter == "phylipfile" )         { phylipfile = value; }
-                               if (parameter == "columnfile" )         { columnfile = value; }                         
-                               if (parameter == "listfile" )           { listfile = value; }
-                               if (parameter == "rabundfile" )         { rabundfile = value; }
-                               if (parameter == "sabundfile" )         { sabundfile = value; }
-                               if (parameter == "namefile" )           { namefile = value; }
-                               if (parameter == "orderfile" )          { orderfile = value; }
-                               if (parameter == "groupfile" )          { groupfile = value; }
-                               if (parameter == "fastafile" )          { fastafile = value; }
-                               if (parameter == "treefile" )           { treefile = value; }
+                               if (parameter == "phylip" )             { phylipfile = value; }
+                               if (parameter == "column" )             { columnfile = value; }                         
+                               if (parameter == "list" )               { listfile = value; }
+                               if (parameter == "rabund" )             { rabundfile = value; }
+                               if (parameter == "sabund" )             { sabundfile = value; }
+                               if (parameter == "name" )               { namefile = value; }
+                               if (parameter == "order" )              { orderfile = value; }
+                               if (parameter == "group" )              { groupfile = value; }
+                               if (parameter == "shared" )             { sharedfile = value; }
+                               if (parameter == "fasta" )              { fastafile = value; }
+                               if (parameter == "tree" )               { treefile = value; }
                                if (parameter == "cutoff" )                     { cutoff = value; }
                                if (parameter == "precision" )          { precision = value; }
                                if (parameter == "iters" )                      { iters = value; }
@@ -160,55 +141,16 @@ bool ErrorCheck::checkInput(string input) {
                                if (parameter == "fileroot" )           { fileroot = value; }
                                if (parameter == "line" )                       { line = value; }
                                if (parameter == "label" )                      { label = value; }
-
-                               if (parameter == "single") {//stores estimators in a vector
-                                       singleEsimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, singleEsimators);
-                                       for (int i = 0; i < singleEsimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, singleEsimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "rarefaction") {//stores estimators in a vector
-                                       rareEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, rareEstimators);
-                                       for (int i = 0; i < rareEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, rareEstimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "shared") {//stores estimators in a vector
-                                       sharedEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, sharedEstimators);
-                                       for (int i = 0; i < sharedEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, sharedEstimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "summary") { //stores summaries to be used in a vector
-                                       summaryEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, summaryEstimators);
-                                       for (int i = 0; i < summaryEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, summaryEstimators[i]) != true) { return false; }
-                                       }
-                               }
-                               if (parameter == "sharedrarefaction") { //stores summaries to be used in a vector
-                                       sharedRareEstimators.clear(); //clears out old values
-                                       globaldata->splitAtDash(value, sharedRareEstimators);
-                                       for (int i = 0; i < sharedRareEstimators.size(); i++) { //loop through estimators
-                                               //is it a valid calculator
-                                               if (validCalculator->isValidCalculator(parameter, sharedRareEstimators[i]) != true) { return false; }
-                                       }
-                               }
-
+                               if (parameter == "random" )                     { randomtree = value;   }
+                               if (parameter == "abund" )          { abund = value; }
+                               if (parameter == "sorted" )                     { sorted = value;       }
                        }
                }
                
                //make sure the user does not use both the line and label parameters
                if ((line != "") && (label != "")) { cout << "You may use either the line or label parameters, but not both." << endl; return false; }
-       
                
+               //check for valid files 
                if (commandName == "read.dist") { 
                        validateReadFiles();
                        validateReadDist();
@@ -216,39 +158,82 @@ bool ErrorCheck::checkInput(string input) {
                        //you want to do shared commands
                        if ((listfile != "") && (groupfile != ""))      {
                                validateParseFiles(); //checks the listfile and groupfile parameters
-                       }else { //you want to do single commands
+                       //you want to do single commands
+                       }else if ((listfile != "") || (rabundfile != "") || (sabundfile != "")){ 
                                validateReadFiles();
                                validateReadPhil();
+                       //you have not given a file
+                       }else if ((listfile == "") && (sharedfile == "") && (rabundfile == "") && (sabundfile == "")) {
+                               cout << "You must enter either a listfile, rabundfile, sabundfile or a sharedfile with the read.otu command. " << endl; return false; 
+                       //you want to do shared commands with a shared file
+                       }else if (sharedfile != "") {//you are reading a shared file
+                               validateReadFiles();
                        }
                }else if (commandName == "read.tree") { 
                        validateTreeFiles(); //checks the treefile and groupfile parameters
                }else if (commandName == "deconvolute") {
+                       if (fastafile == "") { cout << "You must enter a fastafile with the deconvolute() command." << endl; return false; }
                        validateReadFiles();
                }
                
                //are you trying to cluster before you have read something                      
-               if ((commandName == "cluster") && (globaldata->getSparseMatrix() == NULL) ||
-                       (commandName == "cluster") && (globaldata->getListVector() == NULL)) {
+               if (((commandName == "cluster") && (globaldata->gSparseMatrix == NULL)) ||
+                       ((commandName == "cluster") && (globaldata->gListVector == NULL))) {
                                cout << "Before you use the cluster command, you first need to read in a distance matrix." << endl; 
                                errorFree = false;
                } 
                
+               if ((commandName == "libshuff") && ((globaldata->gMatrix == NULL) || (globaldata->gGroupmap == NULL))) {
+                        cout << "You must read in a matrix and groupfile using the read.dist command, before you use the libshuff command. " << endl; return false; 
+               }
+               
+               if (commandName == "parsimony") {
+                       //are you trying to use parsimony without reading a tree or saying you want random distribution
+                       if (randomtree == "")  {
+                               if (globaldata->gTree.size() == 0) {
+                                       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;  }
+                       }
+               }
+               
+               if ((commandName == "unifrac.weighted") || (commandName == "unifrac.unweighted")) {
+                       if (globaldata->gTree.size() == 0) {//no trees were read
+                               cout << "You must execute the read.tree command, before you may execute the unifrac.weighted or unifrac.unweighted command." << endl; return false;  }
+               }
+               
                //check for valid method
+               if(commandName == "get.group") {
+                       if ((globaldata->getGroupFile() == "")) { cout << "You must read a group before you can use the get.group command." << endl; return false; }
+               }
+               if (commandName == "get.label" || commandName == "get.line") {
+                       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; }
+               }
                if (commandName == "cluster") {
                        if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
                        else {cout << "Not a valid clustering method.  Valid clustering algorithms are furthest, nearest or average." << endl; return false; }
                }
                
                if ((commandName == "collect.single") || (commandName == "rarefaction.single") || (commandName == "summary.single") ){ 
-                       if ((globaldata->getListFile() == "") && (globaldata->getRabundFile() == "") && (globaldata->getSabundFile() == "")) { cout << "You must read a listfile, sabundfile or rabundfile before you can use the collect.single, rarefaction.single or summary.single commands." << endl; return false; }
+                       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; }
                }
                
-               if ((commandName == "collect.shared") || (commandName == "rarefaction.shared") || (commandName == "summary.shared") || (commandName == "shared") ){ 
-                       if (globaldata->getListFile() == "") { cout << "You must read a listfile and a groupfile before you can use the collect.shared, rarefaction.shared, summary.shared or shared commands." << endl; return false; }
-                       else if (globaldata->getGroupFile() == "") { cout << "You must read a listfile and a groupfile before you can use the collect.shared, rarefaction.shared, summary.shared or shared commands." << endl; return false; }
+               if ((commandName == "collect.shared") || (commandName == "rarefaction.shared") || (commandName == "summary.shared") ){ 
+                       if (globaldata->getSharedFile() == "") {
+                               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; }
+                               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; }
+                       }
+               }
+               
+               if ((commandName == "heatmap") || (commandName == "venn")) { 
+                       if ((globaldata->getListFile() == "") && (globaldata->getSharedFile() == "")) {
+                                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; 
+                       }
                }
                
+               if ((commandName == "bin.seqs")) { 
+                       if ((globaldata->getListFile() == "")) { cout << "You must read a list file before you can use the bin.seqs command." << endl; return false; }
+                       validateBinFiles();
+               }
+
                return errorFree;
 }
 
@@ -270,7 +255,7 @@ void ErrorCheck::validateReadFiles() {
                        //unable to open
                        if (ableToOpen == 1) { errorFree = false; }
                        else { globaldata->inputFileName = phylipfile; }
-               //are we reading a phylipfile
+               //are we reading a columnfile
                }else if (columnfile != "") {
                        ableToOpen = openInputFile(columnfile, filehandle);
                        filehandle.close();
@@ -304,6 +289,12 @@ void ErrorCheck::validateReadFiles() {
                        //unable to open
                        if (ableToOpen == 1) {  errorFree = false; }
                        else { globaldata->inputFileName = fastafile; }
+               }else if (sharedfile != "") {
+                       ableToOpen = openInputFile(sharedfile, filehandle);
+                       filehandle.close();
+                       //unable to open
+                       if (ableToOpen == 1) {  errorFree = false; }
+                       else { globaldata->inputFileName = sharedfile; }
                }else{ //no file given
                        errorFree = false;
                }
@@ -328,12 +319,19 @@ void ErrorCheck::validateReadDist() {
                ifstream filehandle;
                int ableToOpen;
                
-               if ((phylipfile == "") && (columnfile == "")) { cout << "When executing a read.dist you must enter a phylipfile or a columnfile." << endl; errorFree = false; }
-               else if ((phylipfile != "") && (columnfile != "")) { cout << "When executing a read.dist you must enter ONLY ONE of the following: phylipfile or columnfile." << endl; errorFree = false; }
+               if (groupfile != "") {
+                       ableToOpen = openInputFile(groupfile, filehandle);
+                       filehandle.close();
+                       //unable to open
+                       if (ableToOpen == 1) {  errorFree = false; }
+               }
+               
+               if ((phylipfile == "") && (columnfile == "")) { cout << "When executing a read.dist you must enter a phylip or a column." << endl; errorFree = false; }
+               else if ((phylipfile != "") && (columnfile != "")) { cout << "When executing a read.dist you must enter ONLY ONE of the following: phylip or column." << endl; errorFree = false; }
                
                if (columnfile != "") {
                        if (namefile == "") {
-                               cout << "You need to provide a namefile name if you are going to use the column format." << endl;
+                               cout << "You need to provide a namefile if you are going to use the column format." << endl;
                                errorFree = false; 
                        }else {
                                ableToOpen = openInputFile(namefile, filehandle);
@@ -364,8 +362,8 @@ void ErrorCheck::validateParseFiles() {
                
                //checks for valid files
        
-               if (listfile == "") { cout << "When executing a read.list you must enter a listfile and a groupfile." << endl; errorFree = false; }
-               else if (groupfile == "") { cout << "When executing a read.list you must enter a listfile and a groupfile." << endl; errorFree = false; }
+               if (listfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
+               else if (groupfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
        
                //checks parameters on the read command
                if (listfile != "") {
@@ -446,15 +444,15 @@ void ErrorCheck::validateReadPhil() {
                //checks to make sure only one file type is given
                if (listfile != "") { 
                        if ((rabundfile != "") || (sabundfile != "")) { 
-                               cout << "When executing a read.otu you must enter ONLY ONE of the following: listfile, rabundfile or sabundfile." << endl; errorFree = false; }
+                               cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
                }else if (rabundfile != "") { 
                        if ((listfile != "") || (sabundfile != "")) { 
-                               cout << "When executing a read.otu you must enter ONLY ONE of the following: listfile, rabundfile or sabundfile." << endl; errorFree = false; }
+                               cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
                }else if (sabundfile != "") { 
                        if ((listfile != "") || (rabundfile != "")) { 
-                               cout << "When executing a read.otu you must enter ONLY ONE of the following: listfile, rabundfile or sabundfile." << endl; errorFree = false; }
-               }else if ((listfile == "") && (rabundfile == "") && (sabundfile == "")) {
-                           cout << "When executing a read.otu you must enter one of the following: listfile, rabundfile or sabundfile." << endl; errorFree = false; 
+                               cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
+               }else if ((listfile == "") && (rabundfile == "") && (sabundfile == "") && (sharedfile == "")) {
+                           cout << "When executing a read.otu you must enter one of the following: list, rabund or sabund." << endl; errorFree = false; 
                }
                
                //checks parameters on the read command
@@ -477,6 +475,52 @@ void ErrorCheck::validateReadPhil() {
 }
 /*******************************************************/
 
+/******************************************************/
+//This function checks to make sure the user entered appropriate
+// format parameters on a bin.seq command
+void ErrorCheck::validateBinFiles() {
+       try {
+               ifstream filehandle;
+               int ableToOpen;
+               
+               if (fastafile == "") {
+                               cout << "fasta is a required parameter for bin.seqs." << endl; errorFree = false; 
+               }else if (fastafile != "") {
+                       //is it a valid filename'
+                       ableToOpen = openInputFile(fastafile, filehandle);
+                       filehandle.close();
+                       //unable to open
+                       if (ableToOpen == 1) {  errorFree = false; }
+               }else if (globaldata->getNameFile() != "") {
+                       //is it a valid filename'
+                       ifstream filehandle;
+                       int ableToOpen = openInputFile(globaldata->getNameFile(), filehandle);
+                       filehandle.close();
+                       //unable to open
+                       if (ableToOpen == 1) {  errorFree = false; }
+               }else if (namefile != "") {
+                       //is it a valid filename'
+                       ifstream filehandle;
+                       int ableToOpen = openInputFile(namefile, filehandle);
+                       filehandle.close();
+                       //unable to open
+                       if (ableToOpen == 1) {  errorFree = false; }
+               }
+
+
+       }
+       catch(exception& e) {
+               cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               exit(1);
+       }
+       catch(...) {
+               cout << "An unknown error has occurred in the ErrorCheck class function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               exit(1);
+       }
+}
+
+/*******************************************************/
+
 /******************************************************/
 
 void ErrorCheck::clear() {
@@ -489,6 +533,7 @@ void ErrorCheck::clear() {
        namefile                =       "";
        groupfile               =       ""; 
        orderfile               =       "";
+       sharedfile              =       "";
        line                    =       "";
        label                   =       "";
        method                  =   "furthest";