5 * Created by Sarah Westcott on 1/2/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "errorchecking.h"
12 /*******************************************************/
14 /******************************************************/
16 ErrorCheck::ErrorCheck() {
17 globaldata = GlobalData::getInstance();
18 validCommand = new ValidCommands();
19 validParameter = new ValidParameters();
21 /*******************************************************/
23 /******************************************************/
25 void ErrorCheck::refresh() {
27 //columnfile = globaldata->getColumnFile();
28 //phylipfile = globaldata->getPhylipFile();
29 //listfile = globaldata->getListFile();
30 //rabundfile = globaldata->getRabundFile();
31 //sabundfile = globaldata->getSabundFile();
32 //namefile = globaldata->getNameFile();
33 //groupfile = globaldata->getGroupFile();
34 //orderfile = globaldata->getOrderFile();
35 //fastafile = globaldata->getFastaFile();
36 //treefile = globaldata->getTreeFile();
37 //cutoff = globaldata->getCutOff();
38 //format = globaldata->getFormat();
39 //method = globaldata->getMethod();
40 //randomtree = globaldata->getRandomTree();
41 //sharedfile = globaldata->getSharedFile();
45 /*******************************************************/
47 /******************************************************/
49 ErrorCheck::~ErrorCheck() {
51 delete validParameter;
54 /*******************************************************/
56 /******************************************************/
58 bool ErrorCheck::checkInput(string input) {
65 //get command name and parameters
66 int openParen = input.find_first_of('(');
67 int closeParen = input.find_last_of(')');
69 if(openParen != -1 && closeParen != -1){
70 commandName = input.substr(0, openParen); //commandName contains everything before "("
71 optionText = input.substr(openParen+1, closeParen-openParen-1); //optionString contains everything between "(" and ")".
72 }else if (openParen == -1) { //there is no parenthesis
73 cout << input << " is not a valid command. You are missing the ()." << endl;
77 //is it a valid command
78 if (validCommand->isValidCommand(commandName) != true) { return false; }
79 string parameter, value;
81 //reads in parameters and values
82 if((optionText != "") && (commandName != "help")){
83 while((optionText.find_first_of(',') != -1) && (errorFree)) { //while there are parameters
84 splitAtComma(value, optionText);
85 splitAtEquals(parameter, value);
87 //is it a valid parameter
88 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
90 if (parameter == "phylip" ) { phylipfile = value; }
91 if (parameter == "column" ) { columnfile = value; }
92 if (parameter == "list" ) { listfile = value; }
93 if (parameter == "rabund" ) { rabundfile = value; }
94 if (parameter == "sabund" ) { sabundfile = value; }
95 if (parameter == "name" ) { namefile = value; }
96 if (parameter == "order" ) { orderfile = value; }
97 if (parameter == "fasta" ) { fastafile = value; }
98 if (parameter == "nexus" ) { nexusfile = value; }
99 if (parameter == "clustal" ) { clustalfile = value; }
100 if (parameter == "tree" ) { treefile = value; }
101 if (parameter == "group" ) { groupfile = value; }
102 if (parameter == "shared" ) { sharedfile = value; }
103 if (parameter == "cutoff" ) { cutoff = value; }
104 if (parameter == "precision" ) { precision = value; }
105 if (parameter == "iters" ) { iters = value; }
106 if (parameter == "jumble" ) { jumble = value; }
107 if (parameter == "freq" ) { freq = value; }
108 if (parameter == "method" ) { method = value; }
109 if (parameter == "fileroot" ) { fileroot = value; }
110 if (parameter == "line" ) { line = value; }
111 if (parameter == "label" ) { label = value; }
112 if (parameter == "abund" ) { abund = value; }
113 if (parameter == "random" ) { randomtree = value; }
114 if (parameter == "sorted" ) { sorted = value; }
115 if (parameter == "trump" ) { trump = value; }
116 if (parameter == "soft" ) { soft = value; }
117 if (parameter == "filter" ) { filter = value; }
118 if (parameter == "scale" ) { scale = value; }
119 if (parameter == "ends" ) { ends = value; }
120 if (parameter == "processors" ) { processors = value; }
124 //gets the last parameter and value
125 if (errorFree) { //gets the last parameter and value
127 splitAtEquals(parameter, value);
128 //is it a valid parameter
129 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
132 if (parameter == "phylip" ) { phylipfile = value; }
133 if (parameter == "column" ) { columnfile = value; }
134 if (parameter == "list" ) { listfile = value; }
135 if (parameter == "rabund" ) { rabundfile = value; }
136 if (parameter == "sabund" ) { sabundfile = value; }
137 if (parameter == "name" ) { namefile = value; }
138 if (parameter == "order" ) { orderfile = value; }
139 if (parameter == "group" ) { groupfile = value; }
140 if (parameter == "shared" ) { sharedfile = value; }
141 if (parameter == "fasta" ) { fastafile = value; }
142 if (parameter == "nexus" ) { nexusfile = value; }
143 if (parameter == "clustal" ) { clustalfile = value; }
144 if (parameter == "tree" ) { treefile = value; }
145 if (parameter == "cutoff" ) { cutoff = value; }
146 if (parameter == "precision" ) { precision = value; }
147 if (parameter == "iters" ) { iters = value; }
148 if (parameter == "jumble" ) { jumble = value; }
149 if (parameter == "freq" ) { freq = value; }
150 if (parameter == "method" ) { method = value; }
151 if (parameter == "fileroot" ) { fileroot = value; }
152 if (parameter == "line" ) { line = value; }
153 if (parameter == "label" ) { label = value; }
154 if (parameter == "random" ) { randomtree = value; }
155 if (parameter == "abund" ) { abund = value; }
156 if (parameter == "sorted" ) { sorted = value; }
157 if (parameter == "trump" ) { trump = value; }
158 if (parameter == "soft" ) { soft = value; }
159 if (parameter == "filter" ) { filter = value; }
160 if (parameter == "scale" ) { scale = value; }
161 if (parameter == "ends" ) { ends = value; }
162 if (parameter == "processors" ) { processors = value; }
167 //make sure the user does not use both the line and label parameters
168 if ((line != "") && (label != "")) { cout << "You may use either the line or label parameters, but not both." << endl; return false; }
170 //check for valid files
171 if (commandName == "read.dist") {
174 }else if (commandName == "read.otu") {
175 //you want to do shared commands
176 if ((listfile != "") && (groupfile != "")) {
177 validateParseFiles(); //checks the listfile and groupfile parameters
178 //you want to do single commands
179 }else if ((listfile != "") || (rabundfile != "") || (sabundfile != "")){
182 //you have not given a file
183 }else if ((listfile == "") && (sharedfile == "") && (rabundfile == "") && (sabundfile == "")) {
184 cout << "You must enter either a listfile, rabundfile, sabundfile or a sharedfile with the read.otu command. " << endl; return false;
185 //you want to do shared commands with a shared file
186 }else if (sharedfile != "") {//you are reading a shared file
189 }else if (commandName == "read.tree") {
190 validateTreeFiles(); //checks the treefile and groupfile parameters
191 }else if (commandName == "read.seqs") {
192 if ((fastafile == "") && (nexusfile == "") && (clustalfile == "") && (phylipfile == "")) { cout << "You must enter a fastafile, nexusfile, or clustalfile with the read.seqs() command." << endl; return false; }
193 }else if (commandName == "deconvolute") {
194 if (fastafile == "") { cout << "You must enter a fastafile with the deconvolute() command." << endl; return false; }
198 //are you trying to cluster before you have read something
199 if (((commandName == "cluster") && (globaldata->gSparseMatrix == NULL)) ||
200 ((commandName == "cluster") && (globaldata->gListVector == NULL))) {
201 cout << "Before you use the cluster command, you first need to read in a distance matrix." << endl;
205 if ((commandName == "libshuff") && ((globaldata->gMatrix == NULL) || (globaldata->gGroupmap == NULL))) {
206 cout << "You must read in a matrix and groupfile using the read.dist command, before you use the libshuff command. " << endl; return false;
209 if (commandName == "parsimony") {
210 //are you trying to use parsimony without reading a tree or saying you want random distribution
211 if (randomtree == "") {
212 if (globaldata->gTree.size() == 0) {
213 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; }
217 if ((commandName == "unifrac.weighted") || (commandName == "unifrac.unweighted") || (commandName == "concensus")) {
218 if (globaldata->gTree.size() == 0) {//no trees were read
219 cout << "You must execute the read.tree command, before you may execute the unifrac.weighted, unifrac.unweighted or concensus command." << endl; return false; }
222 //check for valid method
223 if(commandName == "get.group") {
224 if ((globaldata->getGroupFile() == "")) { cout << "You must read a group before you can use the get.group command." << endl; return false; }
226 if (commandName == "get.label" || commandName == "get.line") {
227 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; }
229 if (commandName == "cluster") {
230 if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
231 else {cout << "Not a valid clustering method. Valid clustering algorithms are furthest, nearest or average." << endl; return false; }
234 if ((commandName == "collect.single") || (commandName == "rarefaction.single") || (commandName == "summary.single") ){
235 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; }
238 if ((commandName == "collect.shared") || (commandName == "rarefaction.shared") || (commandName == "summary.shared") || (commandName == "tree.shared") || (commandName == "bootstrap.shared")){
239 if (globaldata->getSharedFile() == "") {
240 if (globaldata->getListFile() == "") { cout << "You must read a list and a group, or a shared before you can use the collect.shared, rarefaction.shared, summary.shared, tree.shared or bootstrap.shared commands." << endl; return false; }
241 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, summary.shared, tree.shared or bootstrap.shared commands." << endl; return false; }
245 if ((commandName == "heatmap") || (commandName == "venn")) {
246 if ((globaldata->getListFile() == "") && (globaldata->getSharedFile() == "")) {
247 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;
251 if (commandName == "filter.seqs"){
252 if ((globaldata->getFastaFile() == "") && (globaldata->getNexusFile() == "") && (globaldata->getClustalFile() == "") && (globaldata->getPhylipFile() == "")) {
253 cout << "You must read either a fasta, nexus, clustal, or phylip file before you can use the filter.seqs command." << endl; return false;
257 if ((commandName == "bin.seqs")) {
258 if ((globaldata->getListFile() == "")) { cout << "You must read a list file before you can use the bin.seqs command." << endl; return false; }
262 if ((commandName == "get.oturep")) {
263 if ((globaldata->gSparseMatrix == NULL) || (globaldata->gListVector == NULL)) {
264 cout << "Before you use the get.oturep command, you first need to read in a distance matrix." << endl;
267 if (listfile == "") { cout << "list is a required parameter for the get.oturep command." << endl; errorFree = false; }
275 /*******************************************************/
277 /******************************************************/
278 //This function checks to make sure the user entered a file to
279 // read and that the file exists and can be opened.
280 void ErrorCheck::validateReadFiles() {
282 //Validating files for read
286 //are we reading a phylipfile
287 if (phylipfile != "") {
288 ableToOpen = openInputFile(phylipfile, filehandle);
291 if (ableToOpen == 1) { errorFree = false; }
292 else { globaldata->inputFileName = phylipfile; }
293 //are we reading a columnfile
294 }else if (columnfile != "") {
295 ableToOpen = openInputFile(columnfile, filehandle);
298 if (ableToOpen == 1) { errorFree = false; }
299 else { globaldata->inputFileName = columnfile; }
300 //are we reading a listfile
301 }else if (listfile!= "") {
302 ableToOpen = openInputFile(listfile, filehandle);
305 if (ableToOpen == 1) { errorFree = false; }
306 else { globaldata->inputFileName = listfile; }
307 //are we reading a rabundfile
308 }else if (rabundfile != "") {
309 ableToOpen = openInputFile(rabundfile, filehandle);
312 if (ableToOpen == 1) { errorFree = false; }
313 else { globaldata->inputFileName = rabundfile; }
314 //are we reading a sabundfile
315 }else if (sabundfile != "") {
316 ableToOpen = openInputFile(sabundfile, filehandle);
319 if (ableToOpen == 1) { errorFree = false; }
320 else { globaldata->inputFileName = sabundfile; }
321 }else if (fastafile != "") {
322 ableToOpen = openInputFile(fastafile, filehandle);
325 if (ableToOpen == 1) { errorFree = false; }
326 else { globaldata->inputFileName = fastafile; }
327 }else if (sharedfile != "") {
328 ableToOpen = openInputFile(sharedfile, filehandle);
331 if (ableToOpen == 1) { errorFree = false; }
332 else { globaldata->inputFileName = sharedfile; }
333 }else{ //no file given
337 catch(exception& e) {
338 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
342 cout << "An unknown error has occurred in the ErrorCheck class function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
347 /*******************************************************/
349 /******************************************************/
350 //This function checks to make sure the user entered appropriate
351 // format parameters on a distfile read
352 void ErrorCheck::validateReadDist() {
357 if (groupfile != "") {
358 ableToOpen = openInputFile(groupfile, filehandle);
361 if (ableToOpen == 1) { errorFree = false; }
364 if ((phylipfile == "") && (columnfile == "")) { cout << "When executing a read.dist you must enter a phylip or a column." << endl; errorFree = false; }
365 else if ((phylipfile != "") && (columnfile != "")) { cout << "When executing a read.dist you must enter ONLY ONE of the following: phylip or column." << endl; errorFree = false; }
367 if (columnfile != "") {
368 if (namefile == "") {
369 cout << "You need to provide a namefile if you are going to use the column format." << endl;
372 ableToOpen = openInputFile(namefile, filehandle);
375 if (ableToOpen == 1) { errorFree = false; }
379 catch(exception& e) {
380 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
384 cout << "An unknown error has occurred in the ErrorCheck class function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
388 /*******************************************************/
390 /******************************************************/
391 //This function checks to make sure the user entered appropriate
392 // format parameters on a parselistcommand
393 void ErrorCheck::validateParseFiles() {
398 //checks for valid files
400 if (listfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
401 else if (groupfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
403 //checks parameters on the read command
404 if (listfile != "") {
405 ableToOpen = openInputFile(listfile, filehandle);
407 if (ableToOpen == 1) { //unable to open
410 if (groupfile != "") {
411 ableToOpen = openInputFile(groupfile, filehandle);
413 if (ableToOpen == 1) { //unable to open
419 catch(exception& e) {
420 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
424 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
428 /*******************************************************/
430 /******************************************************/
431 //This function checks to make sure the user entered appropriate
432 // format parameters on a parselistcommand
433 void ErrorCheck::validateTreeFiles() {
438 //checks for valid files
440 if (treefile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
441 else if (groupfile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
443 //checks parameters on the read command
444 if (treefile != "") {
445 ableToOpen = openInputFile(treefile, filehandle);
447 if (ableToOpen == 1) { //unable to open
450 if (groupfile != "") {
451 ableToOpen = openInputFile(groupfile, filehandle);
453 if (ableToOpen == 1) { //unable to open
459 catch(exception& e) {
460 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
464 cout << "An unknown error has occurred in the ErrorCheck class function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
469 /*******************************************************/
471 /******************************************************/
472 //This function checks to make sure the user entered appropriate
473 // format parameters on a distfile read
474 void ErrorCheck::validateReadPhil() {
479 //checks to make sure only one file type is given
480 if (listfile != "") {
481 if ((rabundfile != "") || (sabundfile != "")) {
482 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
483 }else if (rabundfile != "") {
484 if ((listfile != "") || (sabundfile != "")) {
485 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
486 }else if (sabundfile != "") {
487 if ((listfile != "") || (rabundfile != "")) {
488 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
489 }else if ((listfile == "") && (rabundfile == "") && (sabundfile == "") && (sharedfile == "")) {
490 cout << "When executing a read.otu you must enter one of the following: list, rabund or sabund." << endl; errorFree = false;
493 //checks parameters on the read command
494 if (orderfile != "") {
495 ableToOpen = openInputFile(orderfile, filehandle);
497 if (ableToOpen == 1) { //unable to open
502 catch(exception& e) {
503 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
507 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
511 /*******************************************************/
513 /******************************************************/
514 //This function checks to make sure the user entered appropriate
515 // format parameters on a bin.seq command
516 void ErrorCheck::validateBinFiles() {
521 if (fastafile == "") {
522 cout << "fasta is a required parameter for bin.seqs and get.oturep commands." << endl; errorFree = false;
523 }else if (fastafile != "") {
524 //is it a valid filename'
525 ableToOpen = openInputFile(fastafile, filehandle);
528 if (ableToOpen == 1) { errorFree = false; }
529 }else if (listfile != "") {
530 //is it a valid filename'
531 ableToOpen = openInputFile(listfile, filehandle);
534 if (ableToOpen == 1) { errorFree = false; }
535 }else if (globaldata->getNameFile() != "") {
536 //is it a valid filename'
538 int ableToOpen = openInputFile(globaldata->getNameFile(), filehandle);
541 if (ableToOpen == 1) { errorFree = false; }
542 }else if (namefile != "") {
543 //is it a valid filename'
545 int ableToOpen = openInputFile(namefile, filehandle);
548 if (ableToOpen == 1) { errorFree = false; }
553 catch(exception& e) {
554 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
558 cout << "An unknown error has occurred in the ErrorCheck class function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
563 /*******************************************************/
565 /******************************************************/
567 void ErrorCheck::clear() {
568 //option definitions should go here...
585 /*******************************************************/
587 /******************************************************/