2 * treegroupscommand.cpp
5 * Created by Sarah Westcott on 4/8/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "treegroupscommand.h"
11 #include "sharedjabund.h"
12 #include "sharedsorabund.h"
13 #include "sharedjclass.h"
14 #include "sharedsorclass.h"
15 #include "sharedjest.h"
16 #include "sharedsorest.h"
17 #include "sharedthetayc.h"
18 #include "sharedthetan.h"
19 #include "sharedmorisitahorn.h"
20 #include "sharedbraycurtis.h"
23 //**********************************************************************************************************************
25 TreeGroupCommand::TreeGroupCommand(string option) {
27 globaldata = GlobalData::getInstance();
34 //allow user to run help
35 if(option == "help") { validCalculator = new ValidCalculators(); help(); abort = true; }
38 //valid paramters for this command
39 string Array[] = {"label","calc","groups", "phylip", "column", "name", "precision","cutoff","outputdir","inputdir"};
40 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
42 OptionParser parser(option);
43 map<string, string> parameters = parser. getParameters();
45 ValidParameters validParameter;
46 map<string, string>::iterator it;
48 //check to make sure all parameters are valid for command
49 for (it = parameters.begin(); it != parameters.end(); it++) {
50 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
53 //if the user changes the input directory command factory will send this info to us in the output parameter
54 string inputDir = validParameter.validFile(parameters, "inputdir", false);
55 if (inputDir == "not found"){ inputDir = ""; }
58 it = parameters.find("phylip");
59 //user has given a template file
60 if(it != parameters.end()){
61 path = hasPath(it->second);
62 //if the user has not given a path then, add inputdir. else leave path alone.
63 if (path == "") { parameters["phylip"] = inputDir + it->second; }
66 it = parameters.find("column");
67 //user has given a template file
68 if(it != parameters.end()){
69 path = hasPath(it->second);
70 //if the user has not given a path then, add inputdir. else leave path alone.
71 if (path == "") { parameters["column"] = inputDir + it->second; }
74 it = parameters.find("name");
75 //user has given a template file
76 if(it != parameters.end()){
77 path = hasPath(it->second);
78 //if the user has not given a path then, add inputdir. else leave path alone.
79 if (path == "") { parameters["name"] = inputDir + it->second; }
83 format = globaldata->getFormat();
86 phylipfile = validParameter.validFile(parameters, "phylip", true);
87 if (phylipfile == "not open") { abort = true; }
88 else if (phylipfile == "not found") { phylipfile = ""; }
89 else { format = "phylip"; globaldata->setPhylipFile(phylipfile); }
91 columnfile = validParameter.validFile(parameters, "column", true);
92 if (columnfile == "not open") { abort = true; }
93 else if (columnfile == "not found") { columnfile = ""; }
94 else { format = "column"; globaldata->setColumnFile(columnfile); }
96 namefile = validParameter.validFile(parameters, "name", true);
97 if (namefile == "not open") { abort = true; }
98 else if (namefile == "not found") { namefile = ""; }
99 else { globaldata->setNameFile(namefile); }
101 //error checking on files
102 if ((globaldata->getSharedFile() == "") && ((phylipfile == "") && (columnfile == ""))) { m->mothurOut("You must run the read.otu command or provide a distance file before running the tree.shared command."); m->mothurOutEndLine(); abort = true; }
103 else if ((phylipfile != "") && (columnfile != "")) { m->mothurOut("When running the tree.shared command with a distance file you may not use both the column and the phylip parameters."); m->mothurOutEndLine(); abort = true; }
105 if (columnfile != "") {
106 if (namefile == "") { m->mothurOut("You need to provide a namefile if you are going to use the column format."); m->mothurOutEndLine(); abort = true; }
109 //check for optional parameter and set defaults
110 // ...at some point should added some additional type checking...
111 label = validParameter.validFile(parameters, "label", false);
112 if (label == "not found") { label = ""; }
114 if(label != "all") { splitAtDash(label, labels); allLines = 0; }
115 else { allLines = 1; }
118 //if the user has not specified any labels use the ones from read.otu
120 allLines = globaldata->allLines;
121 labels = globaldata->labels;
124 groups = validParameter.validFile(parameters, "groups", false);
125 if (groups == "not found") { groups = ""; }
127 splitAtDash(groups, Groups);
128 globaldata->Groups = Groups;
131 calc = validParameter.validFile(parameters, "calc", false);
132 if (calc == "not found") { calc = "jclass-thetayc"; }
134 if (calc == "default") { calc = "jclass-thetayc"; }
136 splitAtDash(calc, Estimators);
139 temp = validParameter.validFile(parameters, "precision", false); if (temp == "not found") { temp = "100"; }
140 convert(temp, precision);
142 temp = validParameter.validFile(parameters, "cutoff", false); if (temp == "not found") { temp = "10"; }
143 convert(temp, cutoff);
144 cutoff += (5 / (precision * 10.0));
146 //if the user changes the output directory command factory will send this info to us in the output parameter
147 outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){
149 outputDir += hasPath(globaldata->inputFileName); //if user entered a file with a path then preserve it
153 if (abort == false) {
155 validCalculator = new ValidCalculators();
157 if (format == "sharedfile") {
159 for (i=0; i<Estimators.size(); i++) {
160 if (validCalculator->isValidCalculator("treegroup", Estimators[i]) == true) {
161 if (Estimators[i] == "jabund") {
162 treeCalculators.push_back(new JAbund());
163 }else if (Estimators[i] == "sorabund") {
164 treeCalculators.push_back(new SorAbund());
165 }else if (Estimators[i] == "jclass") {
166 treeCalculators.push_back(new Jclass());
167 }else if (Estimators[i] == "sorclass") {
168 treeCalculators.push_back(new SorClass());
169 }else if (Estimators[i] == "jest") {
170 treeCalculators.push_back(new Jest());
171 }else if (Estimators[i] == "sorest") {
172 treeCalculators.push_back(new SorEst());
173 }else if (Estimators[i] == "thetayc") {
174 treeCalculators.push_back(new ThetaYC());
175 }else if (Estimators[i] == "thetan") {
176 treeCalculators.push_back(new ThetaN());
177 }else if (Estimators[i] == "morisitahorn") {
178 treeCalculators.push_back(new MorHorn());
179 }else if (Estimators[i] == "braycurtis") {
180 treeCalculators.push_back(new BrayCurtis());
189 catch(exception& e) {
190 m->errorOut(e, "TreeGroupCommand", "TreeGroupCommand");
195 //**********************************************************************************************************************
197 void TreeGroupCommand::help(){
199 m->mothurOut("The tree.shared command creates a .tre to represent the similiarity between groups or sequences.\n");
200 m->mothurOut("The tree.shared command can only be executed after a successful read.otu command or by providing a distance file.\n");
201 m->mothurOut("The tree.shared command parameters are groups, calc, phylip, column, name, cutoff, precision and label.\n");
202 m->mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like included used.\n");
203 m->mothurOut("The group names are separated by dashes. The label allow you to select what distance levels you would like trees created for, and are also separated by dashes.\n");
204 m->mothurOut("The phylip or column parameter are required if you do not run the read.otu command first, and only one may be used. If you use a column file the name filename is required. \n");
205 m->mothurOut("If you do not provide a cutoff value 10.00 is assumed. If you do not provide a precision value then 100 is assumed.\n");
206 m->mothurOut("The tree.shared command should be in the following format: tree.shared(groups=yourGroups, calc=yourCalcs, label=yourLabels).\n");
207 m->mothurOut("Example tree.shared(groups=A-B-C, calc=jabund-sorabund).\n");
208 m->mothurOut("The default value for groups is all the groups in your groupfile.\n");
209 m->mothurOut("The default value for calc is jclass-thetayc.\n");
210 m->mothurOut("The tree.shared command outputs a .tre file for each calculator you specify at each distance you choose.\n");
211 validCalculator->printCalc("treegroup", cout);
212 m->mothurOut("Or the tree.shared command can be in the following format: tree.shared(phylip=yourPhylipFile).\n");
213 m->mothurOut("Example tree.shared(phylip=abrecovery.dist).\n");
214 m->mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n");
216 catch(exception& e) {
217 m->errorOut(e, "TreeGroupCommand", "help");
223 //**********************************************************************************************************************
225 TreeGroupCommand::~TreeGroupCommand(){
226 globaldata->Groups.clear();
227 if (abort == false) {
229 if (format == "sharedfile") { delete read; delete input; globaldata->ginput = NULL; }
230 else { delete readMatrix; delete matrix; delete list; }
231 delete tmap; globaldata->gTreemap = NULL;
232 delete validCalculator;
237 //**********************************************************************************************************************
239 int TreeGroupCommand::execute(){
242 if (abort == true) { return 0; }
244 if (format == "sharedfile") {
245 //if the users entered no valid calculators don't execute command
246 if (treeCalculators.size() == 0) { m->mothurOut("You have given no valid calculators."); m->mothurOutEndLine(); return 0; }
249 read = new ReadOTUFile(globaldata->inputFileName);
250 read->read(&*globaldata);
252 input = globaldata->ginput;
253 lookup = input->getSharedRAbundVectors();
254 lastLabel = lookup[0]->getLabel();
256 if (lookup.size() < 2) { m->mothurOut("You have not provided enough valid groups. I cannot run the command."); m->mothurOutEndLine(); return 0; }
258 //used in tree constructor
259 globaldata->runParse = false;
261 //clear globaldatas old tree names if any
262 globaldata->Treenames.clear();
264 //fills globaldatas tree names
265 globaldata->Treenames = globaldata->Groups;
267 //create treemap class from groupmap for tree class to use
268 tmap = new TreeMap();
269 tmap->makeSim(globaldata->gGroupmap);
270 globaldata->gTreemap = tmap;
272 if (m->control_pressed) { return 0; }
277 if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; }
280 filename = globaldata->inputFileName;
282 if (format == "column") { readMatrix = new ReadColumnMatrix(filename); }
283 else if (format == "phylip") { readMatrix = new ReadPhylipMatrix(filename); }
285 readMatrix->setCutoff(cutoff);
288 nameMap = new NameAssignment(namefile);
295 readMatrix->read(nameMap);
296 list = readMatrix->getListVector();
297 matrix = readMatrix->getMatrix();
300 tmap = new TreeMap();
302 if (m->control_pressed) { return 0; }
305 globaldata->gTreemap = tmap;
307 globaldata->Groups = tmap->namesOfGroups;
309 //clear globaldatas old tree names if any
310 globaldata->Treenames.clear();
312 //fills globaldatas tree names
313 globaldata->Treenames = globaldata->Groups;
315 //used in tree constructor
316 globaldata->runParse = false;
318 if (m->control_pressed) { return 0; }
322 if (m->control_pressed) { return 0; }
324 //create a new filename
325 outputFile = outputDir + getRootName(getSimpleName(globaldata->inputFileName)) + "tre";
326 outputNames.push_back(outputFile);
330 if (m->control_pressed) { return 0; }
332 m->mothurOut("Tree complete. "); m->mothurOutEndLine();
336 //reset groups parameter
337 globaldata->Groups.clear();
339 m->mothurOutEndLine();
340 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
341 for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i]); m->mothurOutEndLine(); }
342 m->mothurOutEndLine();
346 catch(exception& e) {
347 m->errorOut(e, "TreeGroupCommand", "execute");
351 //**********************************************************************************************************************
353 int TreeGroupCommand::createTree(){
358 //do merges and create tree structure by setting parents and children
359 //there are numGroups - 1 merges to do
360 for (int i = 0; i < (numGroups - 1); i++) {
361 float largest = -1000.0;
363 if (m->control_pressed) { delete t; return 1; }
366 //find largest value in sims matrix by searching lower triangle
367 for (int j = 1; j < simMatrix.size(); j++) {
368 for (int k = 0; k < j; k++) {
369 if (simMatrix[j][k] > largest) { largest = simMatrix[j][k]; row = j; column = k; }
373 //set non-leaf node info and update leaves to know their parents
375 t->tree[numGroups + i].setChildren(index[row], index[column]);
378 t->tree[index[row]].setParent(numGroups + i);
379 t->tree[index[column]].setParent(numGroups + i);
381 //blength = distance / 2;
382 float blength = ((1.0 - largest) / 2);
385 t->tree[index[row]].setBranchLength(blength - t->tree[index[row]].getLengthToLeaves());
386 t->tree[index[column]].setBranchLength(blength - t->tree[index[column]].getLengthToLeaves());
388 //set your length to leaves to your childs length plus branchlength
389 t->tree[numGroups + i].setLengthToLeaves(t->tree[index[row]].getLengthToLeaves() + t->tree[index[row]].getBranchLength());
393 index[row] = numGroups+i;
394 index[column] = numGroups+i;
396 //remove highest value that caused the merge.
397 simMatrix[row][column] = -1000.0;
398 simMatrix[column][row] = -1000.0;
400 //merge values in simsMatrix
401 for (int n = 0; n < simMatrix.size(); n++) {
402 //row becomes merge of 2 groups
403 simMatrix[row][n] = (simMatrix[row][n] + simMatrix[column][n]) / 2;
404 simMatrix[n][row] = simMatrix[row][n];
406 simMatrix[column][n] = -1000.0;
407 simMatrix[n][column] = -1000.0;
411 //adjust tree to make sure root to tip length is .5
412 int root = t->findRoot();
413 t->tree[root].setBranchLength((0.5 - t->tree[root].getLengthToLeaves()));
418 if (m->control_pressed) { delete t; return 1; }
421 t->createNewickFile(outputFile);
426 if (m->control_pressed) { remove(outputFile.c_str()); outputNames.pop_back(); return 1; }
431 catch(exception& e) {
432 m->errorOut(e, "TreeGroupCommand", "createTree");
436 /***********************************************************/
437 void TreeGroupCommand::printSims(ostream& out) {
440 //output column headers
442 //for (int i = 0; i < lookup.size(); i++) { out << lookup[i]->getGroup() << '\t'; }
446 for (int m = 0; m < simMatrix.size(); m++) {
447 //out << lookup[m]->getGroup() << '\t';
448 for (int n = 0; n < simMatrix.size(); n++) {
449 out << simMatrix[m][n] << '\t';
455 catch(exception& e) {
456 m->errorOut(e, "TreeGroupCommand", "printSims");
460 /***********************************************************/
461 int TreeGroupCommand::makeSimsDist() {
463 numGroups = list->size();
467 for (int g = 0; g < numGroups; g++) { index[g] = g; }
469 //initialize simMatrix
471 simMatrix.resize(numGroups);
472 for (int k = 0; k < simMatrix.size(); k++) {
473 for (int j = 0; j < simMatrix.size(); j++) {
474 simMatrix[k].push_back(0.0);
478 //go through sparse matrix and fill sims
479 //go through each cell in the sparsematrix
480 for(MatData currentCell = matrix->begin(); currentCell != matrix->end(); currentCell++){
481 //similairity = -(distance-1)
482 simMatrix[currentCell->row][currentCell->column] = -(currentCell->dist -1.0);
483 simMatrix[currentCell->column][currentCell->row] = -(currentCell->dist -1.0);
485 if (m->control_pressed) { return 1; }
491 catch(exception& e) {
492 m->errorOut(e, "TreeGroupCommand", "makeSimsDist");
497 /***********************************************************/
498 int TreeGroupCommand::makeSimsShared() {
500 set<string> processedLabels;
501 set<string> userLabels = labels;
503 //as long as you are not at the end of the file or done wih the lines you want
504 while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
505 if (m->control_pressed) { for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; } for(int i = 0 ; i < treeCalculators.size(); i++) { delete treeCalculators[i]; } return 1; }
507 if(allLines == 1 || labels.count(lookup[0]->getLabel()) == 1){
508 m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
511 processedLabels.insert(lookup[0]->getLabel());
512 userLabels.erase(lookup[0]->getLabel());
515 if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
516 string saveLabel = lookup[0]->getLabel();
518 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
519 lookup = input->getSharedRAbundVectors(lastLabel);
521 m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
524 processedLabels.insert(lookup[0]->getLabel());
525 userLabels.erase(lookup[0]->getLabel());
527 //restore real lastlabel to save below
528 lookup[0]->setLabel(saveLabel);
531 lastLabel = lookup[0]->getLabel();
533 //get next line to process
534 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
535 lookup = input->getSharedRAbundVectors();
538 if (m->control_pressed) { for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; } for(int i = 0 ; i < treeCalculators.size(); i++) { delete treeCalculators[i]; } return 1; }
540 //output error messages about any remaining user labels
541 set<string>::iterator it;
542 bool needToRun = false;
543 for (it = userLabels.begin(); it != userLabels.end(); it++) {
544 m->mothurOut("Your file does not include the label " + *it);
545 if (processedLabels.count(lastLabel) != 1) {
546 m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
549 m->mothurOut(". Please refer to " + lastLabel + "."); m->mothurOutEndLine();
553 //run last label if you need to
554 if (needToRun == true) {
555 for (int i = 0; i < lookup.size(); i++) { if (lookup[i] != NULL) { delete lookup[i]; } }
556 lookup = input->getSharedRAbundVectors(lastLabel);
558 m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
560 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
563 for(int i = 0 ; i < treeCalculators.size(); i++) { delete treeCalculators[i]; }
567 catch(exception& e) {
568 m->errorOut(e, "TreeGroupCommand", "makeSimsShared");
573 /***********************************************************/
574 int TreeGroupCommand::process(vector<SharedRAbundVector*> thisLookup) {
577 vector<SharedRAbundVector*> subset;
578 numGroups = thisLookup.size();
580 //for each calculator
581 for(int i = 0 ; i < treeCalculators.size(); i++) {
582 //initialize simMatrix
584 simMatrix.resize(numGroups);
585 for (int k = 0; k < simMatrix.size(); k++) {
586 for (int j = 0; j < simMatrix.size(); j++) {
587 simMatrix[k].push_back(0.0);
593 for (int g = 0; g < numGroups; g++) { index[g] = g; }
595 //create a new filename
596 outputFile = outputDir + getRootName(getSimpleName(globaldata->inputFileName)) + treeCalculators[i]->getName() + "." + thisLookup[0]->getLabel() + ".tre";
597 outputNames.push_back(outputFile);
599 for (int k = 0; k < thisLookup.size(); k++) {
600 for (int l = k; l < thisLookup.size(); l++) {
601 if (k != l) { //we dont need to similiarity of a groups to itself
602 //get estimated similarity between 2 groups
604 subset.clear(); //clear out old pair of sharedrabunds
605 //add new pair of sharedrabunds
606 subset.push_back(thisLookup[k]); subset.push_back(thisLookup[l]);
608 data = treeCalculators[i]->getValues(subset); //saves the calculator outputs
610 if (m->control_pressed) { return 1; }
612 //save values in similarity matrix
613 simMatrix[k][l] = data[0];
614 simMatrix[l][k] = data[0];
619 if (m->control_pressed) { return 1; }
620 //creates tree from similarity matrix and write out file
623 if (m->control_pressed) { return 1; }
629 catch(exception& e) {
630 m->errorOut(e, "TreeGroupCommand", "process");
634 /***********************************************************/