]> git.donarmstrong.com Git - mothur.git/blob - treegroupscommand.cpp
added citation function to commands
[mothur.git] / treegroupscommand.cpp
1 /*
2  *  treegroupscommand.cpp
3  *  Mothur
4  *
5  *  Created by Sarah Westcott on 4/8/09.
6  *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
7  *
8  */
9
10 #include "treegroupscommand.h"
11 #include "sharedsobscollectsummary.h"
12 #include "sharedchao1.h"
13 #include "sharedace.h"
14 #include "sharednseqs.h"
15 #include "sharedjabund.h"
16 #include "sharedsorabund.h"
17 #include "sharedjclass.h"
18 #include "sharedsorclass.h"
19 #include "sharedjest.h"
20 #include "sharedsorest.h"
21 #include "sharedthetayc.h"
22 #include "sharedthetan.h"
23 #include "sharedkstest.h"
24 #include "whittaker.h"
25 #include "sharedochiai.h"
26 #include "sharedanderbergs.h"
27 #include "sharedkulczynski.h"
28 #include "sharedkulczynskicody.h"
29 #include "sharedlennon.h"
30 #include "sharedmorisitahorn.h"
31 #include "sharedbraycurtis.h"
32 #include "sharedjackknife.h"
33 #include "whittaker.h"
34 #include "odum.h"
35 #include "canberra.h"
36 #include "structeuclidean.h"
37 #include "structchord.h"
38 #include "hellinger.h"
39 #include "manhattan.h"
40 #include "structpearson.h"
41 #include "soergel.h"
42 #include "spearman.h"
43 #include "structkulczynski.h"
44 #include "structchi2.h"
45 #include "speciesprofile.h"
46 #include "hamming.h"
47 #include "gower.h"
48 #include "memchi2.h"
49 #include "memchord.h"
50 #include "memeuclidean.h"
51 #include "mempearson.h"
52
53 //**********************************************************************************************************************
54 vector<string> TreeGroupCommand::setParameters(){       
55         try {
56                 CommandParameter pshared("shared", "InputTypes", "", "", "PhylipColumnShared", "PhylipColumnShared", "none",false,false); parameters.push_back(pshared);
57                 CommandParameter pphylip("phylip", "InputTypes", "", "", "PhylipColumnShared", "PhylipColumnShared", "none",false,false); parameters.push_back(pphylip);
58                 CommandParameter pname("name", "InputTypes", "", "", "none", "none", "ColumnName",false,false); parameters.push_back(pname);
59                 CommandParameter pcolumn("column", "InputTypes", "", "", "PhylipColumnShared", "PhylipColumnShared", "ColumnName",false,false); parameters.push_back(pcolumn);          
60                 CommandParameter pcutoff("cutoff", "Number", "", "10", "", "", "",false,false); parameters.push_back(pcutoff);
61                 CommandParameter pprecision("precision", "Number", "", "100", "", "", "",false,false); parameters.push_back(pprecision);                
62                 CommandParameter plabel("label", "String", "", "", "", "", "",false,false); parameters.push_back(plabel);
63                 CommandParameter pgroups("groups", "String", "", "", "", "", "",false,false); parameters.push_back(pgroups);
64                 CommandParameter pcalc("calc", "Multiple", "sharedsobs-sharedchao-sharedace-jabund-sorabund-jclass-sorclass-jest-sorest-thetayc-thetan-kstest-sharednseqs-ochiai-anderberg-kulczynski-kulczynskicody-lennon-morisitahorn-braycurtis-whittaker-odum-canberra-structeuclidean-structchord-hellinger-manhattan-structpearson-soergel-spearman-structkulczynski-speciesprofile-hamming-structchi2-gower-memchi2-memchord-memeuclidean-mempearson", "jclass-thetayc", "", "", "",true,false); parameters.push_back(pcalc);
65                 CommandParameter poutput("output", "Multiple", "lt-square", "lt", "", "", "",false,false); parameters.push_back(poutput);
66                 CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir);
67                 CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir);
68                 
69                 vector<string> myArray;
70                 for (int i = 0; i < parameters.size(); i++) {   myArray.push_back(parameters[i].name);          }
71                 return myArray;
72         }
73         catch(exception& e) {
74                 m->errorOut(e, "TreeGroupCommand", "setParameters");
75                 exit(1);
76         }
77 }
78 //**********************************************************************************************************************
79 string TreeGroupCommand::getHelpString(){       
80         try {
81                 string helpString = "";
82                 ValidCalculators validCalculator;
83                 helpString += "The tree.shared command creates a .tre to represent the similiarity between groups or sequences.\n";
84                 helpString += "The tree.shared command parameters are shared, groups, calc, phylip, column, name, cutoff, precision and label.\n";
85                 helpString += "The groups parameter allows you to specify which of the groups in your groupfile you would like included used.\n";
86                 helpString += "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";
87                 helpString += "The phylip or column parameter are required if you do not provide a sharedfile, and only one may be used.  If you use a column file the name filename is required. \n";
88                 helpString += "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";
89                 helpString += "The tree.shared command should be in the following format: tree.shared(groups=yourGroups, calc=yourCalcs, label=yourLabels).\n";
90                 helpString += "Example tree.shared(groups=A-B-C, calc=jabund-sorabund).\n";
91                 helpString += "The default value for groups is all the groups in your groupfile.\n";
92                 helpString += "The default value for calc is jclass-thetayc.\n";
93                 helpString += "The tree.shared command outputs a .tre file for each calculator you specify at each distance you choose.\n";
94                 helpString += validCalculator.printCalc("treegroup");
95                 helpString += "Or the tree.shared command can be in the following format: tree.shared(phylip=yourPhylipFile).\n";
96                 helpString += "Example tree.shared(phylip=abrecovery.dist).\n";
97                 helpString += "Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n";
98                 return helpString;
99         }
100         catch(exception& e) {
101                 m->errorOut(e, "TreeGroupCommand", "getHelpString");
102                 exit(1);
103         }
104 }
105 //**********************************************************************************************************************
106 TreeGroupCommand::TreeGroupCommand(){   
107         try {
108                 abort = true; calledHelp = true;
109                 setParameters();
110                 //initialize outputTypes
111                 vector<string> tempOutNames;
112                 outputTypes["tree"] = tempOutNames;
113         }
114         catch(exception& e) {
115                 m->errorOut(e, "TreeGroupCommand", "TreeGroupCommand");
116                 exit(1);
117         }
118 }
119 //**********************************************************************************************************************
120
121 TreeGroupCommand::TreeGroupCommand(string option)  {
122         try {
123                 abort = false; calledHelp = false;   
124                 allLines = 1;
125                 
126                 //allow user to run help
127                 if(option == "help") { help(); abort = true; calledHelp = true; }
128                 else if(option == "citation") { citation(); abort = true; calledHelp = true;}
129                 
130                 else {
131                         vector<string> myArray = setParameters();
132                         
133                         OptionParser parser(option);
134                         map<string, string> parameters = parser. getParameters();
135                         
136                         ValidParameters validParameter;
137                         map<string, string>::iterator it;
138                 
139                         //check to make sure all parameters are valid for command
140                         for (it = parameters.begin(); it != parameters.end(); it++) { 
141                                 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {  abort = true;  }
142                         }
143                         
144                         //initialize outputTypes
145                         vector<string> tempOutNames;
146                         outputTypes["tree"] = tempOutNames;
147                         
148                         //if the user changes the input directory command factory will send this info to us in the output parameter 
149                         string inputDir = validParameter.validFile(parameters, "inputdir", false);              
150                         if (inputDir == "not found"){   inputDir = "";          }
151                         else {
152                                 string path;
153                                 it = parameters.find("phylip");
154                                 //user has given a template file
155                                 if(it != parameters.end()){ 
156                                         path = m->hasPath(it->second);
157                                         //if the user has not given a path then, add inputdir. else leave path alone.
158                                         if (path == "") {       parameters["phylip"] = inputDir + it->second;           }
159                                 }
160                                 
161                                 it = parameters.find("column");
162                                 //user has given a template file
163                                 if(it != parameters.end()){ 
164                                         path = m->hasPath(it->second);
165                                         //if the user has not given a path then, add inputdir. else leave path alone.
166                                         if (path == "") {       parameters["column"] = inputDir + it->second;           }
167                                 }
168                                 
169                                 it = parameters.find("name");
170                                 //user has given a template file
171                                 if(it != parameters.end()){ 
172                                         path = m->hasPath(it->second);
173                                         //if the user has not given a path then, add inputdir. else leave path alone.
174                                         if (path == "") {       parameters["name"] = inputDir + it->second;             }
175                                 }
176                         }
177                         
178                         //check for required parameters
179                         phylipfile = validParameter.validFile(parameters, "phylip", true);
180                         if (phylipfile == "not open") { phylipfile = ""; abort = true; }
181                         else if (phylipfile == "not found") { phylipfile = ""; }        
182                         else {  inputfile = phylipfile;  format = "phylip";     }
183                         
184                         columnfile = validParameter.validFile(parameters, "column", true);
185                         if (columnfile == "not open") { columnfile = ""; abort = true; }        
186                         else if (columnfile == "not found") { columnfile = ""; }
187                         else {  inputfile = columnfile; format = "column";      }
188                         
189                         sharedfile = validParameter.validFile(parameters, "shared", true);
190                         if (sharedfile == "not open") { sharedfile = ""; abort = true; }        
191                         else if (sharedfile == "not found") { sharedfile = ""; }
192                         else {  inputfile = sharedfile; format = "sharedfile";  }
193                         
194                         namefile = validParameter.validFile(parameters, "name", true);
195                         if (namefile == "not open") { abort = true; }   
196                         else if (namefile == "not found") { namefile = ""; }
197                         
198                         if ((phylipfile == "") && (columnfile == "") && (sharedfile == "")) { 
199                                 //is there are current file available for either of these?
200                                 //give priority to shared, then column, then phylip
201                                 sharedfile = m->getSharedFile(); 
202                                 if (sharedfile != "") {  inputfile = sharedfile; format = "sharedfile"; m->mothurOut("Using " + sharedfile + " as input file for the shared parameter."); m->mothurOutEndLine(); }
203                                 else { 
204                                         columnfile = m->getColumnFile(); 
205                                         if (columnfile != "") { inputfile = columnfile; format = "column";  m->mothurOut("Using " + columnfile + " as input file for the column parameter."); m->mothurOutEndLine(); }
206                                         else { 
207                                                 phylipfile = m->getPhylipFile(); 
208                                                 if (phylipfile != "") { inputfile = phylipfile;  format = "phylip";  m->mothurOut("Using " + phylipfile + " as input file for the phylip parameter."); m->mothurOutEndLine(); }
209                                                 else { 
210                                                         m->mothurOut("No valid current files. You must provide a shared, phylip or column file."); m->mothurOutEndLine(); 
211                                                         abort = true;
212                                                 }
213                                         }
214                                 }
215                         }
216                         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; }
217                         
218                         if (columnfile != "") {
219                                 if (namefile == "") { 
220                                         namefile = m->getNameFile(); 
221                                         if (namefile != "") {  m->mothurOut("Using " + namefile + " as input file for the name parameter."); m->mothurOutEndLine(); }
222                                         else { 
223                                                 m->mothurOut("You need to provide a namefile if you are going to use the column format."); m->mothurOutEndLine(); 
224                                                 abort = true; 
225                                         }       
226                                 }
227                         }
228                         
229                         //check for optional parameter and set defaults
230                         // ...at some point should added some additional type checking...
231                         label = validParameter.validFile(parameters, "label", false);                   
232                         if (label == "not found") { label = ""; }
233                         else { 
234                                 if(label != "all") {  m->splitAtDash(label, labels);  allLines = 0;  }
235                                 else { allLines = 1;  }
236                         }
237                         
238                         groups = validParameter.validFile(parameters, "groups", false);                 
239                         if (groups == "not found") { groups = ""; }
240                         else { 
241                                 m->splitAtDash(groups, Groups);
242                                 m->Groups = Groups;
243                         }
244                                 
245                         calc = validParameter.validFile(parameters, "calc", false);                     
246                         if (calc == "not found") { calc = "jclass-thetayc";  }
247                         else { 
248                                  if (calc == "default")  {  calc = "jclass-thetayc";  }
249                         }
250                         m->splitAtDash(calc, Estimators);
251
252                         string temp;
253                         temp = validParameter.validFile(parameters, "precision", false);                        if (temp == "not found") { temp = "100"; }
254                         convert(temp, precision); 
255                         
256                         temp = validParameter.validFile(parameters, "cutoff", false);                   if (temp == "not found") { temp = "10"; }
257                         convert(temp, cutoff); 
258                         cutoff += (5 / (precision * 10.0));
259                         
260                         //if the user changes the output directory command factory will send this info to us in the output parameter 
261                         outputDir = validParameter.validFile(parameters, "outputdir", false);           if (outputDir == "not found"){  
262                                 outputDir = ""; 
263                                 outputDir += m->hasPath(inputfile); //if user entered a file with a path then preserve it       
264                         }
265                 }
266
267         }
268         catch(exception& e) {
269                 m->errorOut(e, "TreeGroupCommand", "TreeGroupCommand");
270                 exit(1);
271         }
272 }
273 //**********************************************************************************************************************
274
275 TreeGroupCommand::~TreeGroupCommand(){
276         if (abort == false) {
277                 if (format == "sharedfile") {  delete input; }
278                 else { delete readMatrix;  delete matrix; delete list; }
279                 delete tmap;  
280         }
281         
282 }
283
284 //**********************************************************************************************************************
285
286 int TreeGroupCommand::execute(){
287         try {
288         
289                 if (abort == true) { if (calledHelp) { return 0; }  return 2;   }
290                 
291                 if (format == "sharedfile") {
292                         
293                         ValidCalculators validCalculator;
294                 
295                         for (int i=0; i<Estimators.size(); i++) {
296                                 if (validCalculator.isValidCalculator("treegroup", Estimators[i]) == true) { 
297                                         if (Estimators[i] == "sharedsobs") { 
298                                                 treeCalculators.push_back(new SharedSobsCS());
299                                         }else if (Estimators[i] == "sharedchao") { 
300                                                 treeCalculators.push_back(new SharedChao1());
301                                         }else if (Estimators[i] == "sharedace") { 
302                                                 treeCalculators.push_back(new SharedAce());
303                                         }else if (Estimators[i] == "jabund") {  
304                                                 treeCalculators.push_back(new JAbund());
305                                         }else if (Estimators[i] == "sorabund") { 
306                                                 treeCalculators.push_back(new SorAbund());
307                                         }else if (Estimators[i] == "jclass") { 
308                                                 treeCalculators.push_back(new Jclass());
309                                         }else if (Estimators[i] == "sorclass") { 
310                                                 treeCalculators.push_back(new SorClass());
311                                         }else if (Estimators[i] == "jest") { 
312                                                 treeCalculators.push_back(new Jest());
313                                         }else if (Estimators[i] == "sorest") { 
314                                                 treeCalculators.push_back(new SorEst());
315                                         }else if (Estimators[i] == "thetayc") { 
316                                                 treeCalculators.push_back(new ThetaYC());
317                                         }else if (Estimators[i] == "thetan") { 
318                                                 treeCalculators.push_back(new ThetaN());
319                                         }else if (Estimators[i] == "kstest") { 
320                                                 treeCalculators.push_back(new KSTest());
321                                         }else if (Estimators[i] == "sharednseqs") { 
322                                                 treeCalculators.push_back(new SharedNSeqs());
323                                         }else if (Estimators[i] == "ochiai") { 
324                                                 treeCalculators.push_back(new Ochiai());
325                                         }else if (Estimators[i] == "anderberg") { 
326                                                 treeCalculators.push_back(new Anderberg());
327                                         }else if (Estimators[i] == "kulczynski") { 
328                                                 treeCalculators.push_back(new Kulczynski());
329                                         }else if (Estimators[i] == "kulczynskicody") { 
330                                                 treeCalculators.push_back(new KulczynskiCody());
331                                         }else if (Estimators[i] == "lennon") { 
332                                                 treeCalculators.push_back(new Lennon());
333                                         }else if (Estimators[i] == "morisitahorn") { 
334                                                 treeCalculators.push_back(new MorHorn());
335                                         }else if (Estimators[i] == "braycurtis") { 
336                                                 treeCalculators.push_back(new BrayCurtis());
337                                         }else if (Estimators[i] == "whittaker") { 
338                                                 treeCalculators.push_back(new Whittaker());
339                                         }else if (Estimators[i] == "odum") { 
340                                                 treeCalculators.push_back(new Odum());
341                                         }else if (Estimators[i] == "canberra") { 
342                                                 treeCalculators.push_back(new Canberra());
343                                         }else if (Estimators[i] == "structeuclidean") { 
344                                                 treeCalculators.push_back(new StructEuclidean());
345                                         }else if (Estimators[i] == "structchord") { 
346                                                 treeCalculators.push_back(new StructChord());
347                                         }else if (Estimators[i] == "hellinger") { 
348                                                 treeCalculators.push_back(new Hellinger());
349                                         }else if (Estimators[i] == "manhattan") { 
350                                                 treeCalculators.push_back(new Manhattan());
351                                         }else if (Estimators[i] == "structpearson") { 
352                                                 treeCalculators.push_back(new StructPearson());
353                                         }else if (Estimators[i] == "soergel") { 
354                                                 treeCalculators.push_back(new Soergel());
355                                         }else if (Estimators[i] == "spearman") { 
356                                                 treeCalculators.push_back(new Spearman());
357                                         }else if (Estimators[i] == "structkulczynski") { 
358                                                 treeCalculators.push_back(new StructKulczynski());
359                                         }else if (Estimators[i] == "speciesprofile") { 
360                                                 treeCalculators.push_back(new SpeciesProfile());
361                                         }else if (Estimators[i] == "hamming") { 
362                                                 treeCalculators.push_back(new Hamming());
363                                         }else if (Estimators[i] == "structchi2") { 
364                                                 treeCalculators.push_back(new StructChi2());
365                                         }else if (Estimators[i] == "gower") { 
366                                                 treeCalculators.push_back(new Gower());
367                                         }else if (Estimators[i] == "memchi2") { 
368                                                 treeCalculators.push_back(new MemChi2());
369                                         }else if (Estimators[i] == "memchord") { 
370                                                 treeCalculators.push_back(new MemChord());
371                                         }else if (Estimators[i] == "memeuclidean") { 
372                                                 treeCalculators.push_back(new MemEuclidean());
373                                         }else if (Estimators[i] == "mempearson") { 
374                                                 treeCalculators.push_back(new MemPearson());
375                                         }
376                                 }
377                         }
378                         
379                         //if the users entered no valid calculators don't execute command
380                         if (treeCalculators.size() == 0) { m->mothurOut("You have given no valid calculators."); m->mothurOutEndLine(); return 0; }
381                         
382                         input = new InputData(sharedfile, "sharedfile");
383                         lookup = input->getSharedRAbundVectors();
384                         lastLabel = lookup[0]->getLabel();
385                         
386                         if (lookup.size() < 2) { m->mothurOut("You have not provided enough valid groups.  I cannot run the command."); m->mothurOutEndLine(); return 0; }
387                         
388                         //used in tree constructor 
389                         m->runParse = false;
390                         
391                         //create treemap class from groupmap for tree class to use
392                         tmap = new TreeMap();
393                         tmap->makeSim(m->namesOfGroups);
394                         
395                         //clear globaldatas old tree names if any
396                         m->Treenames.clear();
397                         
398                         //fills globaldatas tree names
399                         m->Treenames = m->Groups;
400                 
401                         if (m->control_pressed) { return 0; }
402                         
403                         //create tree file
404                         makeSimsShared();
405                         
406                         if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str());  } return 0; }
407                 }else{
408                         //read in dist file
409                         filename = inputfile;
410                 
411                         if (format == "column") { readMatrix = new ReadColumnMatrix(filename); }        
412                         else if (format == "phylip") { readMatrix = new ReadPhylipMatrix(filename); }
413                                 
414                         readMatrix->setCutoff(cutoff);
415         
416                         if(namefile != ""){     
417                                 nameMap = new NameAssignment(namefile);
418                                 nameMap->readMap();
419                         }
420                         else{
421                                 nameMap = NULL;
422                         }
423         
424                         readMatrix->read(nameMap);
425                         list = readMatrix->getListVector();
426                         matrix = readMatrix->getMatrix();
427
428                         //make treemap
429                         tmap = new TreeMap();
430                         
431                         if (m->control_pressed) { return 0; }
432                         
433                         tmap->makeSim(list);
434                         
435                         m->Groups = tmap->namesOfGroups;
436                 
437                         //clear globaldatas old tree names if any
438                         m->Treenames.clear();
439                 
440                         //fills globaldatas tree names
441                         m->Treenames = m->Groups;
442                         
443                         //used in tree constructor 
444                         m->runParse = false;
445                         
446                         if (m->control_pressed) { return 0; }
447                         
448                         makeSimsDist();
449                         
450                         if (m->control_pressed) { return 0; }
451
452                         //create a new filename
453                         outputFile = outputDir + m->getRootName(m->getSimpleName(inputfile)) + "tre";   
454                         outputNames.push_back(outputFile); outputTypes["tree"].push_back(outputFile);
455                                 
456                         createTree();
457                         
458                         if (m->control_pressed) { return 0; }
459
460                         m->mothurOut("Tree complete. "); m->mothurOutEndLine();
461                         
462                 }
463                                 
464                 //reset groups parameter
465                 m->Groups.clear(); 
466                 
467                 //set tree file as new current treefile
468                 string current = "";
469                 itTypes = outputTypes.find("tree");
470                 if (itTypes != outputTypes.end()) {
471                         if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setTreeFile(current); }
472                 }
473                 
474                 m->mothurOutEndLine();
475                 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
476                 for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
477                 m->mothurOutEndLine();
478
479                 return 0;
480         }
481         catch(exception& e) {
482                 m->errorOut(e, "TreeGroupCommand", "execute");
483                 exit(1);
484         }
485 }
486 //**********************************************************************************************************************
487
488 int TreeGroupCommand::createTree(){
489         try {
490                 //create tree
491                 t = new Tree(tmap);
492                 
493                 //do merges and create tree structure by setting parents and children
494                 //there are numGroups - 1 merges to do
495                 for (int i = 0; i < (numGroups - 1); i++) {
496                         float largest = -1000.0;
497                         
498                         if (m->control_pressed) { delete t; return 1; }
499                         
500                         int row, column;
501                         //find largest value in sims matrix by searching lower triangle
502                         for (int j = 1; j < simMatrix.size(); j++) {
503                                 for (int k = 0; k < j; k++) {
504                                         if (simMatrix[j][k] > largest) {  largest = simMatrix[j][k]; row = j; column = k;  }
505                                 }
506                         }
507
508                         //set non-leaf node info and update leaves to know their parents
509                         //non-leaf
510                         t->tree[numGroups + i].setChildren(index[row], index[column]);
511                         
512                         //parents
513                         t->tree[index[row]].setParent(numGroups + i);
514                         t->tree[index[column]].setParent(numGroups + i);
515                         
516                         //blength = distance / 2;
517                         float blength = ((1.0 - largest) / 2);
518                         
519                         //branchlengths
520                         t->tree[index[row]].setBranchLength(blength - t->tree[index[row]].getLengthToLeaves());
521                         t->tree[index[column]].setBranchLength(blength - t->tree[index[column]].getLengthToLeaves());
522                         
523                         //set your length to leaves to your childs length plus branchlength
524                         t->tree[numGroups + i].setLengthToLeaves(t->tree[index[row]].getLengthToLeaves() + t->tree[index[row]].getBranchLength());
525                         
526                         
527                         //update index 
528                         index[row] = numGroups+i;
529                         index[column] = numGroups+i;
530                         
531                         //remove highest value that caused the merge.
532                         simMatrix[row][column] = -1000.0;
533                         simMatrix[column][row] = -1000.0;
534                         
535                         //merge values in simsMatrix
536                         for (int n = 0; n < simMatrix.size(); n++)      {
537                                 //row becomes merge of 2 groups
538                                 simMatrix[row][n] = (simMatrix[row][n] + simMatrix[column][n]) / 2;
539                                 simMatrix[n][row] = simMatrix[row][n];
540                                 //delete column
541                                 simMatrix[column][n] = -1000.0;
542                                 simMatrix[n][column] = -1000.0;
543                         }
544                 }
545                 
546                 //adjust tree to make sure root to tip length is .5
547                 int root = t->findRoot();
548                 t->tree[root].setBranchLength((0.5 - t->tree[root].getLengthToLeaves()));
549                 
550                 //assemble tree
551                 t->assembleTree();
552                 
553                 if (m->control_pressed) { delete t; return 1; }
554                 
555                 //print newick file
556                 t->createNewickFile(outputFile);
557                 
558                 //delete tree
559                 delete t;
560                 
561                 if (m->control_pressed) { remove(outputFile.c_str()); outputNames.pop_back(); return 1; }
562                 
563                 return 0;
564         
565         }
566         catch(exception& e) {
567                 m->errorOut(e, "TreeGroupCommand", "createTree");
568                 exit(1);
569         }
570 }
571 /***********************************************************/
572 void TreeGroupCommand::printSims(ostream& out) {
573         try {
574                 
575                 //output column headers
576                 //out << '\t';
577                 //for (int i = 0; i < lookup.size(); i++) {     out << lookup[i]->getGroup() << '\t';           }
578                 //out << endl;
579                 
580                 
581                 for (int m = 0; m < simMatrix.size(); m++)      {
582                         //out << lookup[m]->getGroup() << '\t';
583                         for (int n = 0; n < simMatrix.size(); n++)      {
584                                 out << simMatrix[m][n] << '\t'; 
585                         }
586                         out << endl;
587                 }
588
589         }
590         catch(exception& e) {
591                 m->errorOut(e, "TreeGroupCommand", "printSims");
592                 exit(1);
593         }
594 }
595 /***********************************************************/
596 int TreeGroupCommand::makeSimsDist() {
597         try {
598                 numGroups = list->size();
599                 
600                 //initialize index
601                 index.clear();
602                 for (int g = 0; g < numGroups; g++) {   index[g] = g;   }
603                 
604                 //initialize simMatrix
605                 simMatrix.clear();
606                 simMatrix.resize(numGroups);
607                 for (int k = 0; k < simMatrix.size(); k++)      {
608                         for (int j = 0; j < simMatrix.size(); j++)      {
609                                 simMatrix[k].push_back(0.0);
610                         }
611                 }
612                 
613                 //go through sparse matrix and fill sims
614                 //go through each cell in the sparsematrix
615                 for(MatData currentCell = matrix->begin(); currentCell != matrix->end(); currentCell++){
616                         //similairity = -(distance-1)
617                         simMatrix[currentCell->row][currentCell->column] = -(currentCell->dist -1.0);   
618                         simMatrix[currentCell->column][currentCell->row] = -(currentCell->dist -1.0);   
619                         
620                         if (m->control_pressed) { return 1; }
621                         
622                 }
623
624                 return 0;
625         }
626         catch(exception& e) {
627                 m->errorOut(e, "TreeGroupCommand", "makeSimsDist");
628                 exit(1);
629         }
630 }
631
632 /***********************************************************/
633 int TreeGroupCommand::makeSimsShared() {
634         try {
635                 set<string> processedLabels;
636                 set<string> userLabels = labels;
637                 
638                 //as long as you are not at the end of the file or done wih the lines you want
639                 while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
640                         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; }
641                 
642                         if(allLines == 1 || labels.count(lookup[0]->getLabel()) == 1){                  
643                                 m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
644                                 process(lookup);
645                                 
646                                 processedLabels.insert(lookup[0]->getLabel());
647                                 userLabels.erase(lookup[0]->getLabel());
648                         }
649                         
650                         if ((m->anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
651                                 string saveLabel = lookup[0]->getLabel();
652                         
653                                 for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  } 
654                                 lookup = input->getSharedRAbundVectors(lastLabel);
655
656                                 m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
657                                 process(lookup);
658                                         
659                                 processedLabels.insert(lookup[0]->getLabel());
660                                 userLabels.erase(lookup[0]->getLabel());
661                                 
662                                 //restore real lastlabel to save below
663                                 lookup[0]->setLabel(saveLabel);
664                         }
665
666                         lastLabel = lookup[0]->getLabel();                      
667                         
668                         //get next line to process
669                         for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  } 
670                         lookup = input->getSharedRAbundVectors();
671                 }
672                 
673                 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; }
674
675                 //output error messages about any remaining user labels
676                 set<string>::iterator it;
677                 bool needToRun = false;
678                 for (it = userLabels.begin(); it != userLabels.end(); it++) {  
679                         m->mothurOut("Your file does not include the label " + *it); 
680                         if (processedLabels.count(lastLabel) != 1) {
681                                 m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
682                                 needToRun = true;
683                         }else {
684                                 m->mothurOut(". Please refer to " + lastLabel + "."); m->mothurOutEndLine();
685                         }
686                 }
687                 
688                 //run last label if you need to
689                 if (needToRun == true)  {
690                         for (int i = 0; i < lookup.size(); i++) {  if (lookup[i] != NULL) {             delete lookup[i]; }             } 
691                         lookup = input->getSharedRAbundVectors(lastLabel);
692
693                         m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
694                         process(lookup);
695                         for (int i = 0; i < lookup.size(); i++) {  delete lookup[i];  }         
696                 }
697                 
698                 for(int i = 0 ; i < treeCalculators.size(); i++) {  delete treeCalculators[i]; }
699                 
700                 return 0;
701         }
702         catch(exception& e) {
703                 m->errorOut(e, "TreeGroupCommand", "makeSimsShared");
704                 exit(1);
705         }
706 }
707
708 /***********************************************************/
709 int TreeGroupCommand::process(vector<SharedRAbundVector*> thisLookup) {
710         try{
711                                 EstOutput data;
712                                 vector<SharedRAbundVector*> subset;
713                                 numGroups = thisLookup.size();
714                                 
715                                 //for each calculator                                                                                           
716                                 for(int i = 0 ; i < treeCalculators.size(); i++) {
717                                         //initialize simMatrix
718                                         simMatrix.clear();
719                                         simMatrix.resize(numGroups);
720                                         for (int k = 0; k < simMatrix.size(); k++)      {
721                                                 for (int j = 0; j < simMatrix.size(); j++)      {
722                                                         simMatrix[k].push_back(0.0);
723                                                 }
724                                         }
725                 
726                                         //initialize index
727                                         index.clear();
728                                         for (int g = 0; g < numGroups; g++) {   index[g] = g;   }
729                 
730                                         //create a new filename
731                                         outputFile = outputDir + m->getRootName(m->getSimpleName(inputfile)) + treeCalculators[i]->getName() + "." + thisLookup[0]->getLabel() + ".tre";                                
732                                         outputNames.push_back(outputFile); outputTypes["tree"].push_back(outputFile); 
733                                                                                                 
734                                         for (int k = 0; k < thisLookup.size(); k++) { 
735                                                 for (int l = k; l < thisLookup.size(); l++) {
736                                                         if (k != l) { //we dont need to similiarity of a groups to itself
737                                                                 //get estimated similarity between 2 groups
738                                                                 
739                                                                 subset.clear(); //clear out old pair of sharedrabunds
740                                                                 //add new pair of sharedrabunds
741                                                                 subset.push_back(thisLookup[k]); subset.push_back(thisLookup[l]); 
742                                                                 
743                                                                 //if this calc needs all groups to calculate the pair load all groups
744                                                                 if (treeCalculators[i]->getNeedsAll()) { 
745                                                                         //load subset with rest of lookup for those calcs that need everyone to calc for a pair
746                                                                         for (int w = 0; w < thisLookup.size(); w++) {
747                                                                                 if ((w != k) && (w != l)) { subset.push_back(thisLookup[w]); }
748                                                                         }
749                                                                 }
750                                                                 
751                                                                 data = treeCalculators[i]->getValues(subset); //saves the calculator outputs
752                                                 //cout << thisLookup[k]->getGroup() << '\t' << thisLookup[l]->getGroup() << '\t' << (1.0 - data[0]) << endl;
753                                                                 if (m->control_pressed) { return 1; }
754                                                                 
755                                                                 //save values in similarity matrix
756                                                                 simMatrix[k][l] = data[0];
757                                                                 simMatrix[l][k] = data[0];
758                                                         }
759                                                 }
760                                         }
761                                         
762                                         //createdistance file from simMatrix
763                                         /*string o = outputDir + m->getRootName(m->getSimpleName(globaldata->inputFileName)) + treeCalculators[i]->getName() + "." + thisLookup[0]->getLabel() + ".dist";
764                                         ofstream outDist;
765                                         m->openOutputFile(o, outDist);
766                                         outDist << simMatrix.size() << endl;
767                                         for (int k = 0; k < simMatrix.size(); k++) {
768                                                 outDist << thisLookup[k]->getGroup() << '\t';
769                                                 for (int l = 0; l < k; l++) {
770                                                         outDist << (1.0-simMatrix[k][l]) << '\t';
771                                                 }
772                                                 outDist << endl;
773                                         }
774                                         outDist.close();*/
775
776                                         
777                                         if (m->control_pressed) { return 1; }
778                                         //creates tree from similarity matrix and write out file
779                                         createTree();
780                                         
781                                         if (m->control_pressed) { return 1; }
782                                 }
783                                 
784                                 return 0;
785
786         }
787         catch(exception& e) {
788                 m->errorOut(e, "TreeGroupCommand", "process");
789                 exit(1);
790         }
791 }
792 /***********************************************************/
793
794         
795