]> git.donarmstrong.com Git - mothur.git/blobdiff - unifracweightedcommand.cpp
broke up globaldata and moved error checking and help into commands
[mothur.git] / unifracweightedcommand.cpp
index 91e898f658556d840aab261995ba285c96d84f9d..a7a41f37b820cb8af77ede45cf31d0b0f4885d84 100644 (file)
 #include "unifracweightedcommand.h"
 
 /***********************************************************/
-UnifracWeightedCommand::UnifracWeightedCommand() {
+UnifracWeightedCommand::UnifracWeightedCommand(string option) {
        try {
                globaldata = GlobalData::getInstance();
+               abort = false;
+               Groups.clear();
                
-               T = globaldata->gTree;
-               tmap = globaldata->gTreemap;
-               sumFile = globaldata->getTreeFile() + ".wsummary";
-               openOutputFile(sumFile, outSum);
+               //allow user to run help
+               if(option == "help") { help(); abort = true; }
+               
+               else {
+                       //valid paramters for this command
+                       string Array[] =  {"groups","iters"};
+                       vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+                       
+                       parser = new OptionParser();
+                       parser->parse(option, parameters);  delete parser;
+                       
+                       ValidParameters* validParameter = new ValidParameters();
+               
+                       //check to make sure all parameters are valid for command
+                       for (it4 = parameters.begin(); it4 != parameters.end(); it4++) { 
+                               if (validParameter->isValidParameter(it4->first, myArray, it4->second) != true) {  abort = true;  }
+                       }
+                       
+                       if (globaldata->gTree.size() == 0) {//no trees were read
+                               cout << "You must execute the read.tree command, before you may execute the unifrac.weighted command." << endl; abort = true;  }
+                                                                               
+                       //check for optional parameter and set defaults
+                       // ...at some point should added some additional type checking...
+                       groups = validParameter->validFile(parameters, "groups", false);                        
+                       if (groups == "not found") { groups = ""; }
+                       else { 
+                               splitAtDash(groups, Groups);
+                               globaldata->Groups = Groups;
+                       }
                                
-               setGroups();    //sets the groups the user wants to analyze                     
-               convert(globaldata->getIters(), iters);  //how many random trees to generate
-               weighted = new Weighted(tmap);
-
+                       itersString = validParameter->validFile(parameters, "iters", false);                    if (itersString == "not found") { itersString = "1000"; }
+                       convert(itersString, iters); 
+                       
+                       delete validParameter;
+                       
+                       if (abort == false) {
+                               T = globaldata->gTree;
+                               tmap = globaldata->gTreemap;
+                               sumFile = globaldata->getTreeFile() + ".wsummary";
+                               openOutputFile(sumFile, outSum);
+                               
+                               util = new SharedUtil();
+                               string s; //to make work with setgroups
+                               util->setGroups(globaldata->Groups, tmap->namesOfGroups, s, numGroups, "weighted");     //sets the groups the user wants to analyze
+                               util->getCombos(groupComb, globaldata->Groups, numComp);
+                               
+                               weighted = new Weighted(tmap);
+                               
+                       }
+               }
+               
+               
        }
        catch(exception& e) {
                cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function UnifracWeightedCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
@@ -33,9 +78,38 @@ UnifracWeightedCommand::UnifracWeightedCommand() {
                exit(1);
        }
 }
+//**********************************************************************************************************************
+
+void UnifracWeightedCommand::help(){
+       try {
+               cout << "The unifrac.weighted command can only be executed after a successful read.tree command." << "\n";
+               cout << "The unifrac.weighted command parameters are groups and iters.  No parameters are required." << "\n";
+               cout << "The groups parameter allows you to specify which of the groups in your groupfile you would like analyzed.  You must enter at least 2 valid groups." << "\n";
+               cout << "The group names are separated by dashes.  The iters parameter allows you to specify how many random trees you would like compared to your tree." << "\n";
+               cout << "The unifrac.weighted command should be in the following format: unifrac.weighted(groups=yourGroups, iters=yourIters)." << "\n";
+               cout << "Example unifrac.weighted(groups=A-B-C, iters=500)." << "\n";
+               cout << "The default value for groups is all the groups in your groupfile, and iters is 1000." << "\n";
+               cout << "The unifrac.weighted command output two files: .weighted and .wsummary their descriptions are in the manual." << "\n";
+               cout << "Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups)." << "\n" << "\n";
+       }
+       catch(exception& e) {
+               cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               exit(1);
+       }
+       catch(...) {
+               cout << "An unknown error has occurred in the UnifracWeightedCommand class function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               exit(1);
+       }       
+}
+
 /***********************************************************/
 int UnifracWeightedCommand::execute() {
        try {
+       
+               if (abort == true) { return 0; }
+               
+               Progress* reading;
+               reading = new Progress("Comparing to random:", iters);
                
                //get weighted for users tree
                userData.resize(numComp,0);  //data[0] = weightedscore AB, data[1] = weightedscore AC...
@@ -49,10 +123,9 @@ int UnifracWeightedCommand::execute() {
                        counter = 0;
                        rScores.resize(numComp);  //data[0] = weightedscore AB, data[1] = weightedscore AC...
                        uScores.resize(numComp);  //data[0] = weightedscore AB, data[1] = weightedscore AC...
-                       weightedFile = globaldata->getTreeFile()  + toString(i+1) + ".weighted";
-                       weightedFileout = globaldata->getTreeFile() + "temp." + toString(i+1) + ".weighted";
-                                                       
-                       cout << "Processing tree " << i+1 << endl;
+                       
+                       output = new ColumnFile(globaldata->getTreeFile()  + toString(i+1) + ".weighted", itersString);
+
                        userData = weighted->getValues(T[i]);  //userData[0] = weightedscore
                        
                        //save users score
@@ -82,6 +155,10 @@ int UnifracWeightedCommand::execute() {
                                                count++;
                                        }
                                }
+                               
+                               //update progress bar
+                               reading->update(j);
+
                        }
 
                        //removeValidScoresDuplicates(); 
@@ -104,12 +181,18 @@ int UnifracWeightedCommand::execute() {
                        calculateFreqsCumuls();
                        printWeightedFile();
                        
+                       delete output;
+                       
                        //clear data
                        rScores.clear();
                        uScores.clear();
                        validScores.clear();
                }
                
+               //finish progress bar
+               reading->finish();
+               delete reading;
+               
                printWSummaryFile();
                
                //clear out users groups
@@ -133,22 +216,19 @@ int UnifracWeightedCommand::execute() {
 void UnifracWeightedCommand::printWeightedFile() {
        try {
                vector<double> data;
+               vector<string> tags;
+               tags.push_back("Score"); tags.push_back("RandFreq"); tags.push_back("RandCumul");
                
                for(int a = 0; a < numComp; a++) {
-                       initFile(groupComb[a]);
+                       output->initFile(groupComb[a], tags);
                        //print each line
                        for (it = validScores.begin(); it != validScores.end(); it++) { 
                                data.push_back(it->first);  data.push_back(rScoreFreq[a][it->first]); data.push_back(rCumul[a][it->first]); 
-                               output(data);
+                               output->output(data);
                                data.clear();
                        } 
-                       resetFile();
+                       output->resetFile();
                }
-               
-               out.close();
-               inFile.close();
-               remove(weightedFileout.c_str());
-               
        }
        catch(exception& e) {
                cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function printWeightedFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
@@ -165,8 +245,8 @@ void UnifracWeightedCommand::printWeightedFile() {
 void UnifracWeightedCommand::printWSummaryFile() {
        try {
                //column headers
-               outSum << "Tree#" << '\t' << "Groups" << '\t' << '\t' << "WScore" << '\t' << '\t' << "WSig" <<  endl;
-               cout << "Tree#" << '\t' << "Groups" << '\t' << '\t' << "WScore" << '\t' << '\t' << "WSig" <<  endl;
+               outSum << "Tree#" << '\t' << "Groups" << '\t' << "WScore" << '\t' << "WSig" <<  endl;
+               cout << "Tree#" << '\t' << "Groups" << '\t' << "WScore" << '\t' << "WSig" <<  endl;
                
                //format output
                outSum.setf(ios::fixed, ios::floatfield); outSum.setf(ios::showpoint);
@@ -175,8 +255,13 @@ void UnifracWeightedCommand::printWSummaryFile() {
                int count = 0;
                for (int i = 0; i < T.size(); i++) { 
                        for (int j = 0; j < numComp; j++) {
-                               outSum << setprecision(globaldata->getIters().length()) << i+1 << '\t' << '\t' << groupComb[j] << '\t' << utreeScores[count] << '\t' << WScoreSig[count] << endl; 
-                               cout << setprecision(globaldata->getIters().length()) << i+1 << '\t' << '\t' << groupComb[j] << '\t' << utreeScores[count] << '\t' << WScoreSig[count] << endl; 
+                               if (WScoreSig[count] > (1/(float)iters)) {
+                                       outSum << setprecision(6) << i+1 << '\t' << groupComb[j] << '\t' << utreeScores[count] << '\t' << setprecision(itersString.length()) << WScoreSig[count] << endl; 
+                                       cout << setprecision(6) << i+1 << '\t' << groupComb[j] << '\t' << utreeScores[count] << '\t' << setprecision(itersString.length()) << WScoreSig[count] << endl; 
+                               }else{
+                                       outSum << setprecision(6) << i+1 << '\t' << groupComb[j] << '\t' << utreeScores[count] << '\t' << setprecision(itersString.length()) << "<" << (1/float(iters)) << endl; 
+                                       cout << setprecision(6) << i+1 << '\t' << groupComb[j] << '\t' << utreeScores[count] << '\t' << setprecision(itersString.length()) << "<" << (1/float(iters)) << endl; 
+                               }
                                count++;
                        }
                }
@@ -210,71 +295,6 @@ int UnifracWeightedCommand::findIndex(float score, int index) {
        }
 }
 
-/***********************************************************/
-void UnifracWeightedCommand::setGroups() {
-       try {
-               //if the user has not entered specific groups to analyze then do them all
-               if (globaldata->Groups.size() == 0) {
-                       numGroups = tmap->getNumGroups();
-                       for (int i=0; i < numGroups; i++) { 
-                               globaldata->Groups.push_back(tmap->namesOfGroups[i]);
-                       }
-               }else {
-                       if (globaldata->getGroups() != "all") {
-                               //check that groups are valid
-                               for (int i = 0; i < globaldata->Groups.size(); i++) {
-                                       if (tmap->isValidGroup(globaldata->Groups[i]) != true) {
-                                               cout << globaldata->Groups[i] << " is not a valid group, and will be disregarded." << endl;
-                                               // erase the invalid group from globaldata->Groups
-                                               globaldata->Groups.erase (globaldata->Groups.begin()+i);
-                                       }
-                               }
-                       
-                               //if the user only entered invalid groups
-                               if (globaldata->Groups.size() == 0) { 
-                                       numGroups = tmap->getNumGroups();
-                                       for (int i=0; i < numGroups; i++) { 
-                                               globaldata->Groups.push_back(tmap->namesOfGroups[i]);
-                                       }
-                                       cout << "When using the groups parameter you must have at least 2 valid groups. I will run the command using all the groups in your groupfile." << endl; 
-                               }else if (globaldata->Groups.size() == 1) { 
-                                       cout << "When using the groups parameter you must have at least 2 valid groups. I will run the command using all the groups in your groupfile." << endl;
-                                       numGroups = tmap->getNumGroups();
-                                       globaldata->Groups.clear();
-                                       for (int i=0; i < numGroups; i++) { 
-                                               globaldata->Groups.push_back(tmap->namesOfGroups[i]);
-                                       }
-                               }else { numGroups = globaldata->Groups.size(); }
-                       }else { //users wants all groups
-                               numGroups = tmap->getNumGroups();
-                               globaldata->Groups.clear();
-                               globaldata->setGroups("");
-                               for (int i=0; i < numGroups; i++) { 
-                                       globaldata->Groups.push_back(tmap->namesOfGroups[i]);
-                               }
-                       }
-               }
-               
-               //calculate number of comparisons i.e. with groups A,B,C = AB, AC, BC = 3;
-               numComp = 0;
-               for (int i=0; i<numGroups; i++) { 
-                       numComp += i; 
-                       for (int l = i+1; l < numGroups; l++) {
-                               //set group comparison labels
-                               groupComb.push_back(globaldata->Groups[i]+globaldata->Groups[l]);
-                       }
-               }
-       }
-       catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function setGroups. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-       catch(...) {
-               cout << "An unknown error has occurred in the UnifracWeightedCommand class function setGroups. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-}
-
 /***********************************************************/
 
 void UnifracWeightedCommand::calculateFreqsCumuls() {
@@ -325,84 +345,9 @@ void UnifracWeightedCommand::calculateFreqsCumuls() {
 
 }
 
-/*****************************************************************/
-
-void UnifracWeightedCommand::initFile(string label){
-       try {
-               if(counter != 0){
-                       openOutputFile(weightedFileout, out);
-                       openInputFile(weightedFile, inFile);
-
-                       string inputBuffer;
-                       getline(inFile, inputBuffer);
-               
-                       out     <<  inputBuffer << '\t' << label + "Score" << '\t' << label + "RandFreq" << '\t' << label + "RandCumul" << endl;                
-               }else{
-                       openOutputFile(weightedFileout, out);
-                       out     << label + "Score" << '\t' << label + "RandFreq" << '\t' << label + "RandCumul" << endl;
-               }
-
-               out.setf(ios::fixed, ios::floatfield);
-               out.setf(ios::showpoint);
-       }
-       catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function initFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-       catch(...) {
-               cout << "An unknown error has occurred in the UnifracWeightedCommand class function initFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-}
+/***********************************************************/
 
-/***********************************************************************/
 
-void UnifracWeightedCommand::output(vector<double> data){
-       try {
-               if(counter != 0){               
-                       string inputBuffer;
-                       getline(inFile, inputBuffer);
-               
-                       out     <<  inputBuffer << setprecision(globaldata->getIters().length()) << '\t' << data[0] << '\t' << data[1] << '\t' << data[2] << endl;
-               }
-               else{
-                       out << setprecision(globaldata->getIters().length()) << data[0] << '\t' << data[1] << '\t' << data[2] << endl;
-               }
-
-       }
-       catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function output. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-       catch(...) {
-               cout << "An unknown error has occurred in the UnifracWeightedCommand class function output. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-};
 
-/***********************************************************************/
 
-void UnifracWeightedCommand::resetFile(){
-       try {
-               if(counter != 0){
-                       out.close();
-                       inFile.close();
-               }
-               else{
-                       out.close();
-               }
-               counter = 1;
-               
-               remove(weightedFile.c_str());
-               rename(weightedFileout.c_str(), weightedFile.c_str());
-       }
-       catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the UnifracWeightedCommand class Function resetFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }
-       catch(...) {
-               cout << "An unknown error has occurred in the UnifracWeightedCommand class function resetFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }       
-}