X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=unifracunweightedcommand.cpp;h=24c7b548946a0715e49a7d3818142d50032691fc;hb=191ae1be0679d5cf4eda950b3b1bf26fb7dd503d;hp=1512284544b0e7d4cb7ba6ddac4663bf60d6d777;hpb=92f998cc7debc4bf3e8594848586b8153d96db16;p=mothur.git diff --git a/unifracunweightedcommand.cpp b/unifracunweightedcommand.cpp index 1512284..24c7b54 100644 --- a/unifracunweightedcommand.cpp +++ b/unifracunweightedcommand.cpp @@ -9,19 +9,71 @@ #include "unifracunweightedcommand.h" +//********************************************************************************************************************** +vector UnifracUnweightedCommand::getValidParameters(){ + try { + string Array[] = {"groups","iters","distance","random", "processors","outputdir","inputdir"}; + vector myArray (Array, Array+(sizeof(Array)/sizeof(string))); + return myArray; + } + catch(exception& e) { + m->errorOut(e, "UnifracUnweightedCommand", "getValidParameters"); + exit(1); + } +} +//********************************************************************************************************************** +UnifracUnweightedCommand::UnifracUnweightedCommand(){ + try { + globaldata = GlobalData::getInstance(); + abort = true; + //initialize outputTypes + vector tempOutNames; + outputTypes["unweighted"] = tempOutNames; + outputTypes["uwsummary"] = tempOutNames; + outputTypes["phylip"] = tempOutNames; + } + catch(exception& e) { + m->errorOut(e, "UnifracUnweightedCommand", "UnifracUnweightedCommand"); + exit(1); + } +} +//********************************************************************************************************************** +vector UnifracUnweightedCommand::getRequiredParameters(){ + try { + vector myArray; + return myArray; + } + catch(exception& e) { + m->errorOut(e, "UnifracUnweightedCommand", "getRequiredParameters"); + exit(1); + } +} +//********************************************************************************************************************** +vector UnifracUnweightedCommand::getRequiredFiles(){ + try { + string Array[] = {"tree","group"}; + vector myArray (Array, Array+(sizeof(Array)/sizeof(string))); + + return myArray; + } + catch(exception& e) { + m->errorOut(e, "UnifracUnweightedCommand", "getRequiredFiles"); + exit(1); + } +} /***********************************************************/ -UnifracUnweightedCommand::UnifracUnweightedCommand(string option) { +UnifracUnweightedCommand::UnifracUnweightedCommand(string option) { try { globaldata = GlobalData::getInstance(); abort = false; Groups.clear(); - + //allow user to run help if(option == "help") { help(); abort = true; } else { //valid paramters for this command - string Array[] = {"groups","iters","distance","random"}; + string Array[] = {"groups","iters","distance","random", "processors","outputdir","inputdir"}; vector myArray (Array, Array+(sizeof(Array)/sizeof(string))); OptionParser parser(option); @@ -34,15 +86,27 @@ UnifracUnweightedCommand::UnifracUnweightedCommand(string option) { if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; } } + //initialize outputTypes + vector tempOutNames; + outputTypes["unweighted"] = tempOutNames; + outputTypes["uwsummary"] = tempOutNames; + outputTypes["phylip"] = tempOutNames; + if (globaldata->gTree.size() == 0) {//no trees were read - mothurOut("You must execute the read.tree command, before you may execute the unifrac.unweighted command."); mothurOutEndLine(); abort = true; } - + m->mothurOut("You must execute the read.tree command, before you may execute the unifrac.unweighted command."); m->mothurOutEndLine(); abort = true; } + + //if the user changes the output directory command factory will send this info to us in the output parameter + outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){ + outputDir = ""; + outputDir += m->hasPath(globaldata->inputFileName); //if user entered a file with a path then preserve it + } + //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); + m->splitAtDash(groups, Groups); globaldata->Groups = Groups; } @@ -50,25 +114,29 @@ UnifracUnweightedCommand::UnifracUnweightedCommand(string option) { convert(itersString, iters); string temp = validParameter.validFile(parameters, "distance", false); if (temp == "not found") { temp = "false"; } - phylip = isTrue(temp); + phylip = m->isTrue(temp); - temp = validParameter.validFile(parameters, "random", false); if (temp == "not found") { temp = "true"; } - random = isTrue(temp); + temp = validParameter.validFile(parameters, "random", false); if (temp == "not found") { temp = "f"; } + random = m->isTrue(temp); + + temp = validParameter.validFile(parameters, "processors", false); if (temp == "not found"){ temp = "1"; } + convert(temp, processors); if (!random) { iters = 0; } //turn off random calcs //if user selects distance = true and no groups it won't calc the pairwise if ((phylip) && (Groups.size() == 0)) { groups = "all"; - splitAtDash(groups, Groups); + m->splitAtDash(groups, Groups); globaldata->Groups = Groups; } if (abort == false) { T = globaldata->gTree; tmap = globaldata->gTreemap; - sumFile = globaldata->getTreeFile() + ".uwsummary"; - openOutputFile(sumFile, outSum); + sumFile = outputDir + m->getSimpleName(globaldata->getTreeFile()) + ".uwsummary"; + outputNames.push_back(sumFile); outputTypes["uwsummary"].push_back(sumFile); + m->openOutputFile(sumFile, outSum); util = new SharedUtil(); util->setGroups(globaldata->Groups, tmap->namesOfGroups, allGroups, numGroups, "unweighted"); //sets the groups the user wants to analyze @@ -84,7 +152,7 @@ UnifracUnweightedCommand::UnifracUnweightedCommand(string option) { } catch(exception& e) { - errorOut(e, "UnifracUnweightedCommand", "UnifracUnweightedCommand"); + m->errorOut(e, "UnifracUnweightedCommand", "UnifracUnweightedCommand"); exit(1); } } @@ -93,20 +161,21 @@ UnifracUnweightedCommand::UnifracUnweightedCommand(string option) { void UnifracUnweightedCommand::help(){ try { - mothurOut("The unifrac.unweighted command can only be executed after a successful read.tree command.\n"); - mothurOut("The unifrac.unweighted command parameters are groups, iters, distance and random. No parameters are required.\n"); - mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like analyzed. You must enter at least 1 valid group.\n"); - mothurOut("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"); - mothurOut("The distance parameter allows you to create a distance file from the results. The default is false.\n"); - mothurOut("The random parameter allows you to shut off the comparison to random trees. The default is true, meaning compare your trees with randomly generated trees.\n"); - mothurOut("The unifrac.unweighted command should be in the following format: unifrac.unweighted(groups=yourGroups, iters=yourIters).\n"); - mothurOut("Example unifrac.unweighted(groups=A-B-C, iters=500).\n"); - mothurOut("The default value for groups is all the groups in your groupfile, and iters is 1000.\n"); - mothurOut("The unifrac.unweighted command output two files: .unweighted and .uwsummary their descriptions are in the manual.\n"); - mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n"); + m->mothurOut("The unifrac.unweighted command can only be executed after a successful read.tree command.\n"); + m->mothurOut("The unifrac.unweighted command parameters are groups, iters, distance, processors and random. No parameters are required.\n"); + m->mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like analyzed. You must enter at least 1 valid group.\n"); + m->mothurOut("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"); + m->mothurOut("The distance parameter allows you to create a distance file from the results. The default is false.\n"); + m->mothurOut("The random parameter allows you to shut off the comparison to random trees. The default is false, meaning compare don't your trees with randomly generated trees.\n"); + m->mothurOut("The processors parameter allows you to specify the number of processors to use. The default is 1.\n"); + m->mothurOut("The unifrac.unweighted command should be in the following format: unifrac.unweighted(groups=yourGroups, iters=yourIters).\n"); + m->mothurOut("Example unifrac.unweighted(groups=A-B-C, iters=500).\n"); + m->mothurOut("The default value for groups is all the groups in your groupfile, and iters is 1000.\n"); + m->mothurOut("The unifrac.unweighted command output two files: .unweighted and .uwsummary their descriptions are in the manual.\n"); + m->mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n"); } catch(exception& e) { - errorOut(e, "UnifracUnweightedCommand", "help"); + m->errorOut(e, "UnifracUnweightedCommand", "help"); exit(1); } } @@ -118,18 +187,31 @@ int UnifracUnweightedCommand::execute() { if (abort == true) { return 0; } + int start = time(NULL); + userData.resize(numComp,0); //data[0] = unweightedscore randomData.resize(numComp,0); //data[0] = unweightedscore //create new tree with same num nodes and leaves as users outSum << "Tree#" << '\t' << "Groups" << '\t' << "UWScore" <<'\t' << "UWSig" << endl; - mothurOut("Tree#\tGroups\tUWScore\tUWSig"); mothurOutEndLine(); + m->mothurOut("Tree#\tGroups\tUWScore\tUWSig"); m->mothurOutEndLine(); //get pscores for users trees for (int i = 0; i < T.size(); i++) { + if (m->control_pressed) { + outSum.close(); + for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } + return 0; + } + counter = 0; - if (random) { output = new ColumnFile(globaldata->getTreeFile() + toString(i+1) + ".unweighted", itersString); } + if (random) { + output = new ColumnFile(outputDir + m->getSimpleName(globaldata->getTreeFile()) + toString(i+1) + ".unweighted", itersString); + outputNames.push_back(outputDir + m->getSimpleName(globaldata->getTreeFile()) + toString(i+1) + ".unweighted"); + outputTypes["unweighted"].push_back(outputDir + m->getSimpleName(globaldata->getTreeFile()) + toString(i+1) + ".unweighted"); + } + //get unweighted for users tree rscoreFreq.resize(numComp); @@ -137,7 +219,9 @@ int UnifracUnweightedCommand::execute() { utreeScores.resize(numComp); UWScoreSig.resize(numComp); - userData = unweighted->getValues(T[i]); //userData[0] = unweightedscore + userData = unweighted->getValues(T[i], processors, outputDir); //userData[0] = unweightedscore + + if (m->control_pressed) { if (random) { delete output; } outSum.close(); for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); }return 0; } //output scores for each combination for(int k = 0; k < numComp; k++) { @@ -147,11 +231,14 @@ int UnifracUnweightedCommand::execute() { //add users score to validscores validScores[userData[k]] = userData[k]; } - - //get unweighted scores for random trees + + //get unweighted scores for random trees - if random is false iters = 0 for (int j = 0; j < iters; j++) { + //we need a different getValues because when we swap the labels we only want to swap those in each pairwise comparison - randomData = unweighted->getValues(T[i], "", ""); + randomData = unweighted->getValues(T[i], "", "", processors, outputDir); + + if (m->control_pressed) { if (random) { delete output; } outSum.close(); for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; } for(int k = 0; k < numComp; k++) { //add trees unweighted score to map of scores @@ -165,24 +252,31 @@ int UnifracUnweightedCommand::execute() { //add randoms score to validscores validScores[randomData[k]] = randomData[k]; } + + //report progress + m->mothurOut("Iter: " + toString(j+1)); m->mothurOutEndLine(); } - + for(int a = 0; a < numComp; a++) { float rcumul = 1.0000; - //this loop fills the cumulative maps and put 0.0000 in the score freq map to make it easier to print. - for (map::iterator it = validScores.begin(); it != validScores.end(); it++) { - //make rscoreFreq map and rCumul - map::iterator it2 = rscoreFreq[a].find(it->first); - rCumul[a][it->first] = rcumul; - //get percentage of random trees with that info - if (it2 != rscoreFreq[a].end()) { rscoreFreq[a][it->first] /= iters; rcumul-= it2->second; } - else { rscoreFreq[a][it->first] = 0.0000; } //no random trees with that score - } - if (random) { UWScoreSig[a].push_back(rCumul[a][userData[a]]); } - else { UWScoreSig[a].push_back(0.0); } + if (random) { + //this loop fills the cumulative maps and put 0.0000 in the score freq map to make it easier to print. + for (map::iterator it = validScores.begin(); it != validScores.end(); it++) { + //make rscoreFreq map and rCumul + map::iterator it2 = rscoreFreq[a].find(it->first); + rCumul[a][it->first] = rcumul; + //get percentage of random trees with that info + if (it2 != rscoreFreq[a].end()) { rscoreFreq[a][it->first] /= iters; rcumul-= it2->second; } + else { rscoreFreq[a][it->first] = 0.0000; } //no random trees with that score + } + UWScoreSig[a].push_back(rCumul[a][userData[a]]); + }else { UWScoreSig[a].push_back(0.0); } + } - + + if (m->control_pressed) { if (random) { delete output; } outSum.close(); for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; } + //print output files printUWSummaryFile(i); if (random) { printUnweightedFile(); delete output; } @@ -195,15 +289,23 @@ int UnifracUnweightedCommand::execute() { UWScoreSig.clear(); } - //reset groups parameter - globaldata->Groups.clear(); + outSum.close(); + if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; } + + m->mothurOut("It took " + toString(time(NULL) - start) + " secs to run unifrac.unweighted."); m->mothurOutEndLine(); + + m->mothurOutEndLine(); + m->mothurOut("Output File Names: "); m->mothurOutEndLine(); + for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i]); m->mothurOutEndLine(); } + m->mothurOutEndLine(); + return 0; } catch(exception& e) { - errorOut(e, "UnifracUnweightedCommand", "execute"); + m->errorOut(e, "UnifracUnweightedCommand", "execute"); exit(1); } } @@ -228,7 +330,7 @@ void UnifracUnweightedCommand::printUnweightedFile() { } } catch(exception& e) { - errorOut(e, "UnifracUnweightedCommand", "printUnweightedFile"); + m->errorOut(e, "UnifracUnweightedCommand", "printUnweightedFile"); exit(1); } } @@ -244,37 +346,39 @@ void UnifracUnweightedCommand::printUWSummaryFile(int i) { for(int a = 0; a < numComp; a++) { outSum << i+1 << '\t'; - mothurOut(toString(i+1) + "\t"); + m->mothurOut(toString(i+1) + "\t"); if (random) { if (UWScoreSig[a][0] > (1/(float)iters)) { outSum << setprecision(6) << groupComb[a] << '\t' << utreeScores[a][0] << '\t' << setprecision(itersString.length()) << UWScoreSig[a][0] << endl; cout << setprecision(6) << groupComb[a] << '\t' << utreeScores[a][0] << '\t' << setprecision(itersString.length()) << UWScoreSig[a][0] << endl; - mothurOutJustToLog(groupComb[a] + "\t" + toString(utreeScores[a][0]) + "\t" + toString(UWScoreSig[a][0])); mothurOutEndLine(); + m->mothurOutJustToLog(groupComb[a] + "\t" + toString(utreeScores[a][0]) + "\t" + toString(UWScoreSig[a][0])+ "\n"); }else { outSum << setprecision(6) << groupComb[a] << '\t' << utreeScores[a][0] << '\t' << setprecision(itersString.length()) << "<" << (1/float(iters)) << endl; cout << setprecision(6) << groupComb[a] << '\t' << utreeScores[a][0] << '\t' << setprecision(itersString.length()) << "<" << (1/float(iters)) << endl; - mothurOutJustToLog(groupComb[a] + "\t" + toString(utreeScores[a][0]) + "\t<" + toString((1/float(iters)))); mothurOutEndLine(); + m->mothurOutJustToLog(groupComb[a] + "\t" + toString(utreeScores[a][0]) + "\t<" + toString((1/float(iters))) + "\n"); } }else{ outSum << setprecision(6) << groupComb[a] << '\t' << utreeScores[a][0] << '\t' << "0.00" << endl; cout << setprecision(6) << groupComb[a] << '\t' << utreeScores[a][0] << '\t' << "0.00" << endl; - mothurOutJustToLog(groupComb[a] + "\t" + toString(utreeScores[a][0]) + "\t0.00"); mothurOutEndLine(); + m->mothurOutJustToLog(groupComb[a] + "\t" + toString(utreeScores[a][0]) + "\t0.00\n"); } } } catch(exception& e) { - errorOut(e, "UnifracUnweightedCommand", "printUWSummaryFile"); + m->errorOut(e, "UnifracUnweightedCommand", "printUWSummaryFile"); exit(1); } } /***********************************************************/ void UnifracUnweightedCommand::createPhylipFile(int i) { try { - string phylipFileName = globaldata->getTreeFile() + toString(i+1) + ".unweighted.dist"; + string phylipFileName = outputDir + m->getSimpleName(globaldata->getTreeFile()) + toString(i+1) + ".unweighted.dist"; + outputNames.push_back(phylipFileName); outputTypes["phylip"].push_back(phylipFileName); + ofstream out; - openOutputFile(phylipFileName, out); + m->openOutputFile(phylipFileName, out); //output numSeqs out << globaldata->Groups.size() << endl; @@ -289,8 +393,8 @@ void UnifracUnweightedCommand::createPhylipFile(int i) { int count = 0; for (int r=0; rGroups.size(); r++) { for (int l = r+1; l < globaldata->Groups.size(); l++) { - dists[r][l] = (1.0 - utreeScores[count][0]); - dists[l][r] = (1.0 - utreeScores[count][0]); + dists[r][l] = utreeScores[count][0]; + dists[l][r] = utreeScores[count][0]; count++; } } @@ -311,7 +415,7 @@ void UnifracUnweightedCommand::createPhylipFile(int i) { out.close(); } catch(exception& e) { - errorOut(e, "UnifracUnweightedCommand", "createPhylipFile"); + m->errorOut(e, "UnifracUnweightedCommand", "createPhylipFile"); exit(1); } }