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 == "countends" ) { countends = value; }
120 if (parameter == "processors" ) { processors = value; }
121 if (parameter == "size" ) { size = value; }
122 if (parameter == "candidate") { candidatefile = value; }
123 if (parameter == "search") { search = value; }
124 if (parameter == "ksize") { ksize = value; }
125 if (parameter == "align") { align = value; }
126 if (parameter == "match") { match = value; }
127 if (parameter == "mismatch") { mismatch = value; }
128 if (parameter == "gapopen") { gapopen = value; }
129 if (parameter == "gapextend" ) { gapextend = value; }
132 //gets the last parameter and value
133 if (errorFree) { //gets the last parameter and value
135 splitAtEquals(parameter, value);
136 //is it a valid parameter
137 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
140 if (parameter == "phylip" ) { phylipfile = value; }
141 if (parameter == "column" ) { columnfile = value; }
142 if (parameter == "list" ) { listfile = value; }
143 if (parameter == "rabund" ) { rabundfile = value; }
144 if (parameter == "sabund" ) { sabundfile = value; }
145 if (parameter == "name" ) { namefile = value; }
146 if (parameter == "order" ) { orderfile = value; }
147 if (parameter == "group" ) { groupfile = value; }
148 if (parameter == "shared" ) { sharedfile = value; }
149 if (parameter == "fasta" ) { fastafile = value; }
150 if (parameter == "nexus" ) { nexusfile = value; }
151 if (parameter == "clustal" ) { clustalfile = value; }
152 if (parameter == "tree" ) { treefile = value; }
153 if (parameter == "cutoff" ) { cutoff = value; }
154 if (parameter == "precision" ) { precision = value; }
155 if (parameter == "iters" ) { iters = value; }
156 if (parameter == "jumble" ) { jumble = value; }
157 if (parameter == "freq" ) { freq = value; }
158 if (parameter == "method" ) { method = value; }
159 if (parameter == "fileroot" ) { fileroot = value; }
160 if (parameter == "line" ) { line = value; }
161 if (parameter == "label" ) { label = value; }
162 if (parameter == "random" ) { randomtree = value; }
163 if (parameter == "abund" ) { abund = value; }
164 if (parameter == "sorted" ) { sorted = value; }
165 if (parameter == "trump" ) { trump = value; }
166 if (parameter == "soft" ) { soft = value; }
167 if (parameter == "filter" ) { filter = value; }
168 if (parameter == "scale" ) { scale = value; }
169 if (parameter == "countends" ) { countends = value; }
170 if (parameter == "processors" ) { processors = value; }
171 if (parameter == "size" ) { size = value; }
172 if (parameter == "candidate") { candidatefile = value; }
173 if (parameter == "search") { search = value; }
174 if (parameter == "ksize") { ksize = value; }
175 if (parameter == "align") { align = value; }
176 if (parameter == "match") { match = value; }
177 if (parameter == "mismatch") { mismatch = value; }
178 if (parameter == "gapopen") { gapopen = value; }
179 if (parameter == "gapextend" ) { gapextend = value; }
184 //make sure the user does not use both the line and label parameters
185 if ((line != "") && (label != "")) { cout << "You may use either the line or label parameters, but not both." << endl; return false; }
187 //check for valid files
188 if (commandName == "read.dist") {
191 }else if (commandName == "read.otu") {
192 //you want to do shared commands
193 if ((listfile != "") && (groupfile != "")) {
194 validateParseFiles(); //checks the listfile and groupfile parameters
195 //you want to do single commands
196 }else if ((listfile != "") || (rabundfile != "") || (sabundfile != "")){
199 //you have not given a file
200 }else if ((listfile == "") && (sharedfile == "") && (rabundfile == "") && (sabundfile == "")) {
201 cout << "You must enter either a listfile, rabundfile, sabundfile or a sharedfile with the read.otu command. " << endl; return false;
202 //you want to do shared commands with a shared file
203 }else if (sharedfile != "") {//you are reading a shared file
206 }else if (commandName == "read.tree") {
207 validateTreeFiles(); //checks the treefile and groupfile parameters
208 }else if (commandName == "deconvolute") {
209 if (fastafile == "") { cout << "You must enter a fastafile with the deconvolute() command." << endl; return false; }
213 //are you trying to cluster before you have read something
214 if (((commandName == "cluster") && (globaldata->gSparseMatrix == NULL)) ||
215 ((commandName == "cluster") && (globaldata->gListVector == NULL))) {
216 cout << "Before you use the cluster command, you first need to read in a distance matrix." << endl;
220 if ((commandName == "libshuff") && ((globaldata->gMatrix == NULL) || (globaldata->gGroupmap == NULL))) {
221 cout << "You must read in a matrix and groupfile using the read.dist command, before you use the libshuff command. " << endl; return false;
224 if (commandName == "parsimony") {
225 //are you trying to use parsimony without reading a tree or saying you want random distribution
226 if (randomtree == "") {
227 if (globaldata->gTree.size() == 0) {
228 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; }
232 if ((commandName == "unifrac.weighted") || (commandName == "unifrac.unweighted") || (commandName == "concensus")) {
233 if (globaldata->gTree.size() == 0) {//no trees were read
234 cout << "You must execute the read.tree command, before you may execute the unifrac.weighted, unifrac.unweighted or concensus command." << endl; return false; }
237 //check for valid method
238 if(commandName == "get.group") {
239 if ((globaldata->getSharedFile() == "")) { cout << "You must read a groupfile or a sharedfile before you can use the get.group command." << endl; return false; }
241 if (commandName == "get.label" || commandName == "get.line") {
242 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; }
244 if (commandName == "cluster") {
245 if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
246 else {cout << "Not a valid clustering method. Valid clustering algorithms are furthest, nearest or average." << endl; return false; }
249 if ((commandName == "collect.single") || (commandName == "rarefaction.single") || (commandName == "summary.single") ){
250 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; }
253 if ((commandName == "collect.shared") || (commandName == "rarefaction.shared") || (commandName == "summary.shared") || (commandName == "bootstrap.shared") || (commandName == "dist.shared")){
254 if (globaldata->getSharedFile() == "") {
255 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, bootstrap.shared or dist.shared commands." << endl; return false; }
256 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, bootstrap.shared or dist.shared commands." << endl; return false; }
260 if (commandName == "tree.shared") {
262 if ((globaldata->getSharedFile() == "") && ((phylipfile == "") && (columnfile == ""))) { cout << "You must run the read.otu command or provide a distance file before running the tree.shared command." << endl; return false; }
263 //you want to do single commands
264 else if ((globaldata->getSharedFile() == "") && ((phylipfile != "") || (columnfile != ""))) {
269 if ((commandName == "heatmap") || (commandName == "venn")) {
270 if ((globaldata->getListFile() == "") && (globaldata->getSharedFile() == "")) {
271 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;
275 if ((commandName == "filter.seqs") || (commandName == "dist.seqs")) {
276 if ((fastafile == "") && (nexusfile == "") && (clustalfile == "") && (phylipfile == "")) {
277 cout << "You must enter either a fasta, nexus, clustal, or phylip file before you can use the filter.seqs or dist.seqs command." << endl; return false;
282 if (commandName == "align.seqs") {
283 if ((fastafile == "") || (candidatefile == "")) {
284 cout << "You must enter fasta and a candidate file to use the align.seqs command." << endl; return false;
289 if ((commandName == "bin.seqs")) {
290 if ((globaldata->getListFile() == "")) { cout << "You must read a list file before you can use the bin.seqs commands." << endl; return false; }
295 if ((commandName == "get.oturep")) {
296 if ((globaldata->gSparseMatrix == NULL) || (globaldata->gListVector == NULL)) {
297 cout << "Before you use the get.oturep command, you first need to read in a distance matrix." << endl;
300 if (listfile == "") { cout << "list is a required parameter for the get.oturep command." << endl; errorFree = false; }
308 /*******************************************************/
310 /******************************************************/
311 //This function checks to make sure the user entered a file to
312 // read and that the file exists and can be opened.
313 void ErrorCheck::validateReadFiles() {
315 //Validating files for read
319 //are we reading a phylipfile
320 if (phylipfile != "") {
321 ableToOpen = openInputFile(phylipfile, filehandle);
324 if (ableToOpen == 1) { errorFree = false; }
325 else { globaldata->inputFileName = phylipfile; }
326 //are we reading a columnfile
327 }else if (columnfile != "") {
328 ableToOpen = openInputFile(columnfile, filehandle);
331 if (ableToOpen == 1) { errorFree = false; }
332 else { globaldata->inputFileName = columnfile; }
333 //are we reading a listfile
334 }else if (listfile!= "") {
335 ableToOpen = openInputFile(listfile, filehandle);
338 if (ableToOpen == 1) { errorFree = false; }
339 else { globaldata->inputFileName = listfile; }
340 //are we reading a rabundfile
341 }else if (rabundfile != "") {
342 ableToOpen = openInputFile(rabundfile, filehandle);
345 if (ableToOpen == 1) { errorFree = false; }
346 else { globaldata->inputFileName = rabundfile; }
347 //are we reading a sabundfile
348 }else if (sabundfile != "") {
349 ableToOpen = openInputFile(sabundfile, filehandle);
352 if (ableToOpen == 1) { errorFree = false; }
353 else { globaldata->inputFileName = sabundfile; }
354 }else if (fastafile != "") {
355 ableToOpen = openInputFile(fastafile, filehandle);
358 if (ableToOpen == 1) { errorFree = false; }
359 else { globaldata->inputFileName = fastafile; }
360 }else if (sharedfile != "") {
361 ableToOpen = openInputFile(sharedfile, filehandle);
364 if (ableToOpen == 1) { errorFree = false; }
365 else { globaldata->inputFileName = sharedfile; }
366 }else if (groupfile != "") {
367 ableToOpen = openInputFile(groupfile, filehandle);
369 if (ableToOpen == 1) { //unable to open
372 }else{ //no file given
376 catch(exception& e) {
377 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
381 cout << "An unknown error has occurred in the ErrorCheck class function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
386 /*******************************************************/
388 /******************************************************/
389 //This function checks to make sure the user entered appropriate
390 // format parameters on a distfile read
391 void ErrorCheck::validateReadDist() {
396 if (groupfile != "") {
397 ableToOpen = openInputFile(groupfile, filehandle);
400 if (ableToOpen == 1) { errorFree = false; }
403 if ((phylipfile == "") && (columnfile == "")) { cout << "When executing a read.dist or a tree.shared command with a distance file you must enter a phylip or a column." << endl; errorFree = false; }
404 else if ((phylipfile != "") && (columnfile != "")) { cout << "When executing a read.dist or a tree.shared command with a distance file you must enter ONLY ONE of the following: phylip or column." << endl; errorFree = false; }
406 if (columnfile != "") {
407 if (namefile == "") {
408 cout << "You need to provide a namefile if you are going to use the column format." << endl;
411 ableToOpen = openInputFile(namefile, filehandle);
414 if (ableToOpen == 1) { errorFree = false; }
418 catch(exception& e) {
419 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
423 cout << "An unknown error has occurred in the ErrorCheck class function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
427 /*******************************************************/
429 /******************************************************/
430 //This function checks to make sure the user entered appropriate
431 // format parameters on a parselistcommand
432 void ErrorCheck::validateParseFiles() {
437 //checks for valid files
439 if (listfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
440 else if (groupfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
442 //checks parameters on the read command
443 if (listfile != "") {
444 ableToOpen = openInputFile(listfile, filehandle);
446 if (ableToOpen == 1) { //unable to open
449 if (groupfile != "") {
450 ableToOpen = openInputFile(groupfile, filehandle);
452 if (ableToOpen == 1) { //unable to open
458 catch(exception& e) {
459 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
463 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
467 /*******************************************************/
469 /******************************************************/
470 //This function checks to make sure the user entered appropriate
471 // format parameters on a parselistcommand
472 void ErrorCheck::validateTreeFiles() {
477 //checks for valid files
479 if (treefile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
480 else if (groupfile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
482 //checks parameters on the read command
483 if (treefile != "") {
484 ableToOpen = openInputFile(treefile, filehandle);
486 if (ableToOpen == 1) { //unable to open
489 if (groupfile != "") {
490 ableToOpen = openInputFile(groupfile, filehandle);
492 if (ableToOpen == 1) { //unable to open
498 catch(exception& e) {
499 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
503 cout << "An unknown error has occurred in the ErrorCheck class function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
508 /*******************************************************/
510 /******************************************************/
511 //This function checks to make sure the user entered appropriate
512 // format parameters on a distfile read
513 void ErrorCheck::validateReadPhil() {
518 //checks to make sure only one file type is given
519 if (listfile != "") {
520 if ((rabundfile != "") || (sabundfile != "")) {
521 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
522 }else if (rabundfile != "") {
523 if ((listfile != "") || (sabundfile != "")) {
524 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
525 }else if (sabundfile != "") {
526 if ((listfile != "") || (rabundfile != "")) {
527 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
528 }else if ((listfile == "") && (rabundfile == "") && (sabundfile == "") && (sharedfile == "")) {
529 cout << "When executing a read.otu you must enter one of the following: list, rabund or sabund." << endl; errorFree = false;
532 //checks parameters on the read command
533 if (orderfile != "") {
534 ableToOpen = openInputFile(orderfile, filehandle);
536 if (ableToOpen == 1) { //unable to open
541 catch(exception& e) {
542 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
546 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
550 /*******************************************************/
552 /******************************************************/
553 //This function checks to make sure the user entered appropriate
554 // format parameters on a distfile read
555 void ErrorCheck::validateSeqsFiles() {
560 //checks to make sure only one file type is given
561 if (phylipfile != "") {
562 if ((nexusfile != "") || (fastafile != "") || (clustalfile != "")) {
563 cout << "You may enter ONLY ONE of the following: phylip, fasta, nexus or clustal." << endl; errorFree = false; }
565 ableToOpen = openInputFile(phylipfile, filehandle);
567 if (ableToOpen == 1) { //unable to open
571 }else if (nexusfile != "") {
572 if ((phylipfile != "") || (fastafile != "") || (clustalfile != "")) {
573 cout << "You may enter ONLY ONE of the following: phylip, fasta, nexus or clustal." << endl; errorFree = false; }
575 ableToOpen = openInputFile(nexusfile, filehandle);
577 if (ableToOpen == 1) { //unable to open
581 }else if (fastafile != "") {
582 if ((phylipfile != "") || (nexusfile != "") || (clustalfile != "")) {
583 cout << "You may enter ONLY ONE of the following: phylip, fasta, nexus or clustal." << endl; errorFree = false; }
585 ableToOpen = openInputFile(fastafile, filehandle);
587 if (ableToOpen == 1) { //unable to open
591 }else if (clustalfile != "") {
592 if ((phylipfile != "") || (nexusfile != "") || (fastafile != "")) {
593 cout << "You may enter ONLY ONE of the following: phylip, fasta, nexus or clustal." << endl; errorFree = false; }
595 ableToOpen = openInputFile(clustalfile, filehandle);
597 if (ableToOpen == 1) { //unable to open
601 }else if (candidatefile != "") {
602 ableToOpen = openInputFile(candidatefile, filehandle);
604 if (ableToOpen == 1) { //unable to open
611 catch(exception& e) {
612 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateSeqsFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
616 cout << "An unknown error has occurred in the ErrorCheck class function validateSeqsFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
621 /*******************************************************/
623 /******************************************************/
624 //This function checks to make sure the user entered appropriate
625 // format parameters on a bin.seq command
626 void ErrorCheck::validateBinFiles() {
631 if (fastafile == "") {
632 cout << "fasta is a required parameter for bin.seqs, get.oturep and get.repseqs commands." << endl; errorFree = false;
633 }else if (fastafile != "") {
634 //is it a valid filename'
635 ableToOpen = openInputFile(fastafile, filehandle);
638 if (ableToOpen == 1) { errorFree = false; }
639 }else if (listfile != "") {
640 //is it a valid filename'
641 ableToOpen = openInputFile(listfile, filehandle);
644 if (ableToOpen == 1) { errorFree = false; }
645 }else if (globaldata->getNameFile() != "") {
646 //is it a valid filename'
648 int ableToOpen = openInputFile(globaldata->getNameFile(), filehandle);
651 if (ableToOpen == 1) { errorFree = false; }
652 }else if (namefile != "") {
653 //is it a valid filename'
655 int ableToOpen = openInputFile(namefile, filehandle);
658 if (ableToOpen == 1) { errorFree = false; }
659 }else if (groupfile != "") {
660 //is it a valid filename'
662 int ableToOpen = openInputFile(groupfile, filehandle);
665 if (ableToOpen == 1) { errorFree = false; }
671 catch(exception& e) {
672 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
676 cout << "An unknown error has occurred in the ErrorCheck class function validateBinFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
681 /*******************************************************/
683 /******************************************************/
685 void ErrorCheck::clear() {
686 //option definitions should go here...
704 /*******************************************************/
706 /******************************************************/