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() {
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();
43 /*******************************************************/
45 /******************************************************/
47 ErrorCheck::~ErrorCheck() {
49 delete validParameter;
52 /*******************************************************/
54 /******************************************************/
56 bool ErrorCheck::checkInput(string input) {
63 //get command name and parameters
64 int openParen = input.find_first_of('(');
65 int closeParen = input.find_last_of(')');
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;
75 //is it a valid command
76 if (validCommand->isValidCommand(commandName) != true) { return false; }
78 string parameter, value;
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);
86 //is it a valid parameter
87 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
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; }
115 //gets the last parameter and value
116 if (errorFree) { //gets the last parameter and value
118 splitAtEquals(parameter, value);
119 //is it a valid parameter
120 if (validParameter->isValidParameter(parameter, commandName, value) != true) { return false; }
123 if (parameter == "phylip" ) { phylipfile = value; }
124 if (parameter == "column" ) { columnfile = value; }
125 if (parameter == "list" ) { listfile = value; }
126 if (parameter == "rabund" ) { rabundfile = value; }
127 if (parameter == "sabund" ) { sabundfile = value; }
128 if (parameter == "name" ) { namefile = value; }
129 if (parameter == "order" ) { orderfile = value; }
130 if (parameter == "group" ) { groupfile = value; }
131 if (parameter == "shared" ) { sharedfile = value; }
132 if (parameter == "fasta" ) { fastafile = value; }
133 if (parameter == "tree" ) { treefile = value; }
134 if (parameter == "cutoff" ) { cutoff = value; }
135 if (parameter == "precision" ) { precision = value; }
136 if (parameter == "iters" ) { iters = value; }
137 if (parameter == "jumble" ) { jumble = value; }
138 if (parameter == "freq" ) { freq = value; }
139 if (parameter == "method" ) { method = value; }
140 if (parameter == "fileroot" ) { fileroot = value; }
141 if (parameter == "line" ) { line = value; }
142 if (parameter == "label" ) { label = value; }
143 if (parameter == "random" ) { randomtree = value; }
144 if (parameter == "abund" ) { abund = value; }
148 //make sure the user does not use both the line and label parameters
149 if ((line != "") && (label != "")) { cout << "You may use either the line or label parameters, but not both." << endl; return false; }
151 //check for valid files
152 if (commandName == "read.dist") {
155 }else if (commandName == "read.otu") {
156 //you want to do shared commands
157 if ((listfile != "") && (groupfile != "")) {
158 validateParseFiles(); //checks the listfile and groupfile parameters
159 //you want to do single commands
160 }else if ((listfile != "") || (rabundfile != "") || (sabundfile != "")){
163 //you have not given a file
164 }else if ((listfile == "") && (sharedfile == "") && (rabundfile == "") && (sabundfile == "")) {
165 cout << "You must enter either a listfile, rabundfile, sabundfile or a sharedfile with the read.otu command. " << endl; return false;
166 //you want to do shared commands with a shared file
167 }else if (sharedfile != "") {//you are reading a shared file
170 }else if (commandName == "read.tree") {
171 validateTreeFiles(); //checks the treefile and groupfile parameters
172 }else if (commandName == "deconvolute") {
173 if (fastafile == "") { cout << "You must enter a fastafile with the deconvolute() command." << endl; return false; }
177 //are you trying to cluster before you have read something
178 if (((commandName == "cluster") && (globaldata->gSparseMatrix == NULL)) ||
179 ((commandName == "cluster") && (globaldata->gListVector == NULL))) {
180 cout << "Before you use the cluster command, you first need to read in a distance matrix." << endl;
184 if ((commandName == "libshuff") && ((globaldata->gMatrix == NULL) || (globaldata->gGroupmap == NULL))) {
185 cout << "You must read in a matrix and groupfile using the read.dist command, before you use the libshuff command. " << endl; return false;
188 if (commandName == "parsimony") {
189 //are you trying to use parsimony without reading a tree or saying you want random distribution
190 if (randomtree == "") {
191 if (globaldata->gTree.size() == 0) {
192 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; }
196 if ((commandName == "unifrac.weighted") || (commandName == "unifrac.unweighted")) {
197 if (globaldata->gTree.size() == 0) {//no trees were read
198 cout << "You must execute the read.tree command, before you may execute the unifrac.weighted or unifrac.unweighted command." << endl; return false; }
201 //check for valid method
202 if(commandName == "get.group") {
203 if ((globaldata->getGroupFile() == "")) { cout << "You must read a group before you can use the get.group command." << endl; return false; }
205 if (commandName == "get.label" || commandName == "get.line") {
206 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; }
208 if (commandName == "cluster") {
209 if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
210 else {cout << "Not a valid clustering method. Valid clustering algorithms are furthest, nearest or average." << endl; return false; }
213 if ((commandName == "collect.single") || (commandName == "rarefaction.single") || (commandName == "summary.single") ){
214 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 if ((commandName == "collect.shared") || (commandName == "rarefaction.shared") || (commandName == "summary.shared") ){
218 if (globaldata->getSharedFile() == "") {
219 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; }
220 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; }
224 if (commandName == "heatmap"){
225 if ((globaldata->getListFile() == "") && (globaldata->getSharedFile() == "")) {
226 cout << "You must read a list, or a list and a group, or a shared before you can use the heatmap command." << endl; return false;
233 /*******************************************************/
235 /******************************************************/
236 //This function checks to make sure the user entered a file to
237 // read and that the file exists and can be opened.
238 void ErrorCheck::validateReadFiles() {
240 //Validating files for read
244 //are we reading a phylipfile
245 if (phylipfile != "") {
246 ableToOpen = openInputFile(phylipfile, filehandle);
249 if (ableToOpen == 1) { errorFree = false; }
250 else { globaldata->inputFileName = phylipfile; }
251 //are we reading a columnfile
252 }else if (columnfile != "") {
253 ableToOpen = openInputFile(columnfile, filehandle);
256 if (ableToOpen == 1) { errorFree = false; }
257 else { globaldata->inputFileName = columnfile; }
258 //are we reading a listfile
259 }else if (listfile!= "") {
260 ableToOpen = openInputFile(listfile, filehandle);
263 if (ableToOpen == 1) { errorFree = false; }
264 else { globaldata->inputFileName = listfile; }
265 //are we reading a rabundfile
266 }else if (rabundfile != "") {
267 ableToOpen = openInputFile(rabundfile, filehandle);
270 if (ableToOpen == 1) { errorFree = false; }
271 else { globaldata->inputFileName = rabundfile; }
272 //are we reading a sabundfile
273 }else if (sabundfile != "") {
274 ableToOpen = openInputFile(sabundfile, filehandle);
277 if (ableToOpen == 1) { errorFree = false; }
278 else { globaldata->inputFileName = sabundfile; }
279 }else if (fastafile != "") {
280 ableToOpen = openInputFile(fastafile, filehandle);
283 if (ableToOpen == 1) { errorFree = false; }
284 else { globaldata->inputFileName = fastafile; }
285 }else if (sharedfile != "") {
286 ableToOpen = openInputFile(sharedfile, filehandle);
289 if (ableToOpen == 1) { errorFree = false; }
290 else { globaldata->inputFileName = sharedfile; }
291 }else{ //no file given
295 catch(exception& e) {
296 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
300 cout << "An unknown error has occurred in the ErrorCheck class function validateReadFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
305 /*******************************************************/
307 /******************************************************/
308 //This function checks to make sure the user entered appropriate
309 // format parameters on a distfile read
310 void ErrorCheck::validateReadDist() {
315 if (groupfile != "") {
316 ableToOpen = openInputFile(groupfile, filehandle);
319 if (ableToOpen == 1) { errorFree = false; }
322 if ((phylipfile == "") && (columnfile == "")) { cout << "When executing a read.dist you must enter a phylip or a column." << endl; errorFree = false; }
323 else if ((phylipfile != "") && (columnfile != "")) { cout << "When executing a read.dist you must enter ONLY ONE of the following: phylip or column." << endl; errorFree = false; }
325 if (columnfile != "") {
326 if (namefile == "") {
327 cout << "You need to provide a namefile if you are going to use the column format." << endl;
330 ableToOpen = openInputFile(namefile, filehandle);
333 if (ableToOpen == 1) { errorFree = false; }
337 catch(exception& e) {
338 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
342 cout << "An unknown error has occurred in the ErrorCheck class function validateReadDist. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
346 /*******************************************************/
348 /******************************************************/
349 //This function checks to make sure the user entered appropriate
350 // format parameters on a parselistcommand
351 void ErrorCheck::validateParseFiles() {
356 //checks for valid files
358 if (listfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
359 else if (groupfile == "") { cout << "When executing a read.otu for groups you must enter a list and a group." << endl; errorFree = false; }
361 //checks parameters on the read command
362 if (listfile != "") {
363 ableToOpen = openInputFile(listfile, filehandle);
365 if (ableToOpen == 1) { //unable to open
368 if (groupfile != "") {
369 ableToOpen = openInputFile(groupfile, filehandle);
371 if (ableToOpen == 1) { //unable to open
377 catch(exception& e) {
378 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
382 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. 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 parselistcommand
391 void ErrorCheck::validateTreeFiles() {
396 //checks for valid files
398 if (treefile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
399 else if (groupfile == "") { cout << "When executing a read.tree you must enter a treefile and a groupfile." << endl; errorFree = false; }
401 //checks parameters on the read command
402 if (treefile != "") {
403 ableToOpen = openInputFile(treefile, filehandle);
405 if (ableToOpen == 1) { //unable to open
408 if (groupfile != "") {
409 ableToOpen = openInputFile(groupfile, filehandle);
411 if (ableToOpen == 1) { //unable to open
417 catch(exception& e) {
418 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateTreeFiles. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
422 cout << "An unknown error has occurred in the ErrorCheck class function validateTreeFiles. 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 distfile read
432 void ErrorCheck::validateReadPhil() {
437 //checks to make sure only one file type is given
438 if (listfile != "") {
439 if ((rabundfile != "") || (sabundfile != "")) {
440 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
441 }else if (rabundfile != "") {
442 if ((listfile != "") || (sabundfile != "")) {
443 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
444 }else if (sabundfile != "") {
445 if ((listfile != "") || (rabundfile != "")) {
446 cout << "When executing a read.otu you must enter ONLY ONE of the following: list, rabund or sabund." << endl; errorFree = false; }
447 }else if ((listfile == "") && (rabundfile == "") && (sabundfile == "") && (sharedfile == "")) {
448 cout << "When executing a read.otu you must enter one of the following: list, rabund or sabund." << endl; errorFree = false;
451 //checks parameters on the read command
452 if (orderfile != "") {
453 ableToOpen = openInputFile(orderfile, filehandle);
455 if (ableToOpen == 1) { //unable to open
460 catch(exception& e) {
461 cout << "Standard Error: " << e.what() << " has occurred in the ErrorCheck class Function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
465 cout << "An unknown error has occurred in the ErrorCheck class function validateReadPhil. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
469 /*******************************************************/
471 /******************************************************/
473 void ErrorCheck::clear() {
474 //option definitions should go here...
488 /*******************************************************/
490 /******************************************************/