5 * Created by Sarah Westcott on 1/5/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "validparameter.h"
12 /***********************************************************************/
14 ValidParameters::ValidParameters() {
16 initCommandParameters();
17 initParameterRanges();
21 cout << "Standard Error: " << e.what() << " has occurred in the ValidParameters class Function ValidParameters. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
25 cout << "An unknown error has occurred in the ValidParameters class function ValidParameters. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
30 /***********************************************************************/
32 ValidParameters::~ValidParameters() {}
35 /***********************************************************************/
36 bool ValidParameters::isValidParameter(string parameter, string command, string value) {
39 vector<string> cParams = commandParameters[command];
40 int numParams = cParams.size();
41 for(int i = 0; i < numParams; i++)
43 if(cParams.at(i).compare(parameter) == 0)
51 cout << "'" << parameter << "' is not a valid parameter for the " << command << " command.\n";
55 if(parameterRanges.count(parameter) != 1)
59 double piSentinel = 3.14159;
60 vector<string> range = parameterRanges[parameter];
62 valid = convertTest(value, pVal);
69 /********************************************************************************************************
71 *********************************************************************************************************/
73 if(parameter.compare("precision") == 0)
75 double logNum = log10((double)pVal);
76 double diff = (double)((int)logNum - logNum);
79 cout << "The precision parameter can only take powers of 10 as a value (e.g. 10,1000,1000, etc.)\n";
84 /************************************************************************************************************/
90 if(range.at(1).compare("NA") == 0)
93 a = atoi(range.at(1).c_str());
95 if(range.at(3).compare("NA") == 0)
98 b = atoi(range.at(3).c_str());
100 if(range.at(4).compare("between") == 0)
102 else if(range.at(4).compare("only") == 0)
106 cout << "The range can only be 'between' or 'only' the bounding numbers.\n";
110 if(range.at(0).compare(">") == 0)
112 else if(range.at(0).compare(">=") == 0 || range[3].compare("=>") == 0)
116 cout << "The parameter value can only be '>', '>=', or '=>' the lower bounding number.\n";
120 if(range.at(2).compare("<") == 0)
122 else if(range.at(2).compare("<=") == 0 || range[4].compare("=<") == 0)
126 cout << "The parameter value can only be '<', '<=', or '=<' the upper bounding number.\n";
137 if(a == piSentinel && b == piSentinel)
139 if(a != piSentinel && b == piSentinel)
146 else if(a == piSentinel && b != piSentinel)
157 else if(d == 0 && e == 1)
159 else if(d == 1 && e == 0)
167 if(a == piSentinel && b == piSentinel)
169 if(a != piSentinel && b == piSentinel)
171 else if(a == piSentinel && b != piSentinel)
174 valid = (pVal == a || pVal == b);
182 cout << "The '" << parameter << "' parameter needs to be ";
184 cout << "either '" << a << "' or '" << b << "'.\n";
192 cout << " '" << a << "'";
196 else if(a != piSentinel)
203 cout << " '" << b << ".\n";
209 catch(exception& e) {
210 cout << "Standard Error: " << e.what() << " has occurred in the ValidParameters class Function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
214 cout << "An unknown error has occurred in the ValidParameters class function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
219 /***********************************************************************/
221 /***********************************************************************/
222 void ValidParameters::initCommandParameters() {
224 //{"parameter1","parameter2",...,"last parameter"};
226 string readdistArray[] = {"phylip","column", "name","cutoff","precision"};
227 commandParameters["read.dist"] = addParameters(readdistArray, sizeof(readdistArray)/sizeof(string));
229 string readotuArray[] = {"list","order","shared", "line", "label","group","shared", "sabund", "rabund"};
230 commandParameters["read.otu"] = addParameters(readotuArray, sizeof(readotuArray)/sizeof(string));
232 string readtreeArray[] = {"tree","group"};
233 commandParameters["read.tree"] = addParameters(readtreeArray, sizeof(readtreeArray)/sizeof(string));
235 string clusterArray[] = {"cutoff","precision","method"};
236 commandParameters["cluster"] = addParameters(clusterArray, sizeof(clusterArray)/sizeof(string));
238 string deconvoluteArray[] = {"fasta"};
239 commandParameters["deconvolute"] = addParameters(deconvoluteArray, sizeof(deconvoluteArray)/sizeof(string));
241 string collectsingleArray[] = {"freq","line","label","calc","precision","abund"};
242 commandParameters["collect.single"] = addParameters(collectsingleArray, sizeof(collectsingleArray)/sizeof(string));
244 string collectsharedArray[] = {"jumble","freq","line","label","calc","groups"};
245 commandParameters["collect.shared"] = addParameters(collectsharedArray, sizeof(collectsharedArray)/sizeof(string));
247 string getgroupArray[] = {};
248 commandParameters["get.group"] = addParameters(getgroupArray, sizeof(getgroupArray)/sizeof(string));
250 string getlabelArray[] = {};
251 commandParameters["get.label"] = addParameters(getlabelArray, sizeof(getlabelArray)/sizeof(string));
253 string getlineArray[] = {};
254 commandParameters["get.line"] = addParameters(getlineArray, sizeof(getlineArray)/sizeof(string));
256 string rarefactionsingleArray[] = {"iters","freq","line","label","calc","abund"};
257 commandParameters["rarefaction.single"] = addParameters(rarefactionsingleArray, sizeof(rarefactionsingleArray)/sizeof(string));
259 string rarefactionsharedArray[] = {"iters","jumble","line","label","calc"};
260 commandParameters["rarefaction.shared"] = addParameters(rarefactionsharedArray, sizeof(rarefactionsharedArray)/sizeof(string));
262 string libshuffArray[] = {"iters","groups","step","form","cutoff"};
263 commandParameters["libshuff"] = addParameters(libshuffArray, sizeof(libshuffArray)/sizeof(string));
265 string summarysingleArray[] = {"line","label","calc","abund"};
266 commandParameters["summary.single"] = addParameters(summarysingleArray, sizeof(summarysingleArray)/sizeof(string));
268 string summarysharedArray[] = {"jumble","line","label","calc"};
269 commandParameters["summary.shared"] = addParameters(summarysharedArray, sizeof(summarysharedArray)/sizeof(string));
271 string parsimonyArray[] = {"random","group","iters"};
272 commandParameters["parsimony"] = addParameters(parsimonyArray, sizeof(parsimonyArray)/sizeof(string));
274 string unifracWeightedArray[] = {"group","iters"};
275 commandParameters["unifrac.weighted"] = addParameters(unifracWeightedArray, sizeof(unifracWeightedArray)/sizeof(string));
277 string unifracUnweightedArray[] = {"group","iters"};
278 commandParameters["unifrac.unweighted"] = addParameters(unifracUnweightedArray, sizeof(unifracUnweightedArray)/sizeof(string));
280 string heatmapArray[] = {"group","line","label","sorted"};
281 commandParameters["heatmap"] = addParameters(heatmapArray, sizeof(heatmapArray)/sizeof(string));
283 string quitArray[] = {};
284 commandParameters["quit"] = addParameters(quitArray, sizeof(quitArray)/sizeof(string));
287 catch(exception& e) {
288 cout << "Standard Error: " << e.what() << " has occurred in the ValidParameters class Function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
292 cout << "An unknown error has occurred in the ValidParameters class function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
297 /***********************************************************************/
299 /***********************************************************************/
300 void ValidParameters::initParameterRanges() {
304 /**************************************************************************************************************
305 {">=" or "=>" or ">" if the value should be greater than or equal to or just greater than the lower bound,
306 A number representing the lower bound ("NA" if there is no lower bound),
307 "<=" or "=<" or "<" if the value shoud be less than or equal to or just less than the upper bound,
308 A number representing the upper bound ("NA" if there is no lower bound),
309 "between" if between lower and upper bounds or "only" if exactly one of the bounds};
312 # (>, >=) lower bound, # (<, <=) upperbound, # should be (between, only) lower and upper bounds.
313 ***********************************************************************************************************/
315 string precisionArray[] = {">=","10", "<","NA", "between"};
316 parameterRanges["precision"] = addParameters(precisionArray, rangeSize);
318 string itersArray[] = {">=","10", "<","NA", "between"};
319 parameterRanges["iters"] = addParameters(itersArray, rangeSize);
321 string jumbleArray[] = {">","0", "<","1", "only"};
322 parameterRanges["jumble"] = addParameters(jumbleArray, rangeSize);
324 string freqArray[] = {">","1", "<","NA", "between"};
325 parameterRanges["freq"] = addParameters(freqArray, rangeSize);
327 string lineArray[] = {">=","1", "<","NA", "between"};
328 parameterRanges["line"] = addParameters(lineArray, rangeSize);
330 string abundArray[] = {">=","5", "<","NA", "between"};
331 parameterRanges["abund"] = addParameters(abundArray, rangeSize);
333 catch(exception& e) {
334 cout << "Standard Error: " << e.what() << " has occurred in the ValidParameters class Function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
338 cout << "An unknown error has occurred in the ValidParameters class function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
343 /***********************************************************************/
345 /***********************************************************************/
346 vector<string> ValidParameters::addParameters(string parameters[], int size) {
348 vector<string> pVector (parameters, parameters+size);
351 catch(exception& e) {
352 cout << "Standard Error: " << e.what() << " has occurred in the ValidParameters class Function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
356 cout << "An unknown error has occurred in the ValidParameters class function isValidParameter. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";