File: readtree.cpp

package info (click to toggle)
mothur 1.33.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 11,248 kB
  • ctags: 12,231
  • sloc: cpp: 152,046; fortran: 665; makefile: 74; sh: 34
file content (428 lines) | stat: -rw-r--r-- 11,740 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
/*
 *  readtree.cpp
 *  Mothur
 *
 *  Created by Sarah Westcott on 1/22/09.
 *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
 *
 */

#include "readtree.h"

/***********************************************************************/
ReadTree::ReadTree() {
	try {
		m = MothurOut::getInstance();
	}
	catch(exception& e) {
		m->errorOut(e, "ReadTree", "ReadTree");
		exit(1);
	}
}
/***********************************************************************/
int ReadTree::AssembleTrees() {
	 try {
		 //assemble users trees
		 for (int i = 0; i < Trees.size(); i++) {
			 if (m->control_pressed) { return 0;  }
			 Trees[i]->assembleTree();
		 }
		 return 0;
	 }
	catch(exception& e) {
		m->errorOut(e, "ReadTree", "AssembleTrees");
		exit(1);
	}
}
/***********************************************************************/
int ReadTree::readSpecialChar(istream& f, char c, string name) {
    try {
	
		m->gobble(f);
		char d = f.get();
	
		if(d == EOF){
			m->mothurOut("Error: Input file ends prematurely, expecting a " + name + "\n");
			exit(1);
		}
		if(d != c){
			m->mothurOut("Error: Expected " + name + " in input file.  Found " + toString(d) + ".\n");
			exit(1);
		}
		if(d == ')' && f.peek() == '\n'){
			m->gobble(f);
		}	
		return d;
	}
	catch(exception& e) {
		m->errorOut(e, "ReadTree", "readSpecialChar");
		exit(1);
	}
}
/**************************************************************************************************/

int ReadTree::readNodeChar(istream& f) {
	try {
//		while(isspace(d=f.get()))		{;}
		m->gobble(f);
		char d = f.get();

		if(d == EOF){
			m->mothurOut("Error: Input file ends prematurely, expecting a left parenthesis\n");
			exit(1);
		}
		return d;
	}
	catch(exception& e) {
		m->errorOut(e, "ReadTree", "readNodeChar");
		exit(1);
	}
}

/**************************************************************************************************/

float ReadTree::readBranchLength(istream& f) {
    try {
		float b;
	
		if(!(f >> b)){
			m->mothurOut("Error: Missing branch length in input tree.\n");
			exit(1);
		}
		m->gobble(f);
		return b;
	}
	catch(exception& e) {
		m->errorOut(e, "ReadTree", "readBranchLength");
		exit(1);
	}
}

/***********************************************************************/
/***********************************************************************/

//Child Classes Below

/***********************************************************************/
/***********************************************************************/
//This class reads a file in Newick form and stores it in a tree.

int ReadNewickTree::read(CountTable* ct) {
	try {
		holder = "";
		int c, error;
		int comment = 0;
		
		//if you are not a nexus file 
		if ((c = filehandle.peek()) != '#') {  
			while((c = filehandle.peek()) != EOF) {
                if (m->control_pressed) {  filehandle.close(); return 0; }
				while ((c = filehandle.peek()) != EOF) {
                    if (m->control_pressed) {  filehandle.close(); return 0; }
					// get past comments
					if(c == '[') {
						comment = 1;
					}
					if(c == ']'){
						comment = 0;
					}
					if((c == '(') && (comment != 1)){ break; }
					filehandle.get();
				}

				//make new tree
				T = new Tree(ct); 

				numNodes = T->getNumNodes();
				numLeaves = T->getNumLeaves();
				
				error = readTreeString(ct); 
				
				//save trees for later commands
				Trees.push_back(T); 
				m->gobble(filehandle);
			}
		//if you are a nexus file
		}else if ((c = filehandle.peek()) == '#') {
			//get right number of seqs from nexus file.
			Tree* temp = new Tree(ct);  delete temp;
			
			nexusTranslation(ct);  //reads file through the translation and updates treemap
			while((c = filehandle.peek()) != EOF) {
                if (m->control_pressed) {  filehandle.close(); return 0; }
				// get past comments
				while ((c = filehandle.peek()) != EOF) {
                    if (m->control_pressed) {  filehandle.close(); return 0; }
					if(holder == "[" || holder == "[!"){
						comment = 1;
					}
					if(holder == "]"){
						comment = 0;
					}
					if((holder == "tree" || holder == "end;") && comment != 1){ holder = ""; comment = 0; break;}
					filehandle >> holder;
				}
			
				//pass over the "tree rep.6878900 = "
				while (((c = filehandle.get()) != '(') && ((c = filehandle.peek()) != EOF) ) {;}
					
				if (c == EOF ) { break; }
				filehandle.putback(c);  //put back first ( of tree.
				
				//make new tree
				T = new Tree(ct); 
				numNodes = T->getNumNodes();
				numLeaves = T->getNumLeaves();
				
				//read tree info
				error = readTreeString(ct); 
				 
				//save trees for later commands
				Trees.push_back(T); 
			}
		}
		
		if (error != 0) { readOk = error; } 
		
		filehandle.close();

		return readOk;
	}
	catch(exception& e) {
		m->errorOut(e, "ReadNewickTree", "read");
		exit(1);
	}
}
/**************************************************************************************************/
//This function read the file through the translation of the sequences names and updates treemap.
string ReadNewickTree::nexusTranslation(CountTable* ct) {
	try {
		
		holder = "";
		int numSeqs = m->Treenames.size(); //must save this some when we clear old names we can still know how many sequences there were
		int comment = 0;
		
		// get past comments
		while(holder != "translate" && holder != "Translate"){	
			if(holder == "[" || holder == "[!"){
				comment = 1;
			}
			if(holder == "]"){
				comment = 0;
			}
			filehandle >> holder; 
			if(holder == "tree" && comment != 1){return holder;}
		}
    
		string number, name;
		for(int i=0;i<numSeqs;i++){
			
			filehandle >> number;
			filehandle >> name;
			name.erase(name.end()-1);  //erase the comma
			ct->renameSeq(name, toString(number));
		}
		
		return name;
	}
	catch(exception& e) {
		m->errorOut(e, "ReadNewickTree", "nexusTranslation");
		exit(1);
	}
}

/**************************************************************************************************/
int ReadNewickTree::readTreeString(CountTable* ct) {
	try {
		
		int n = 0;
		int lc, rc; 
		
		int rooted = 0;
	
		int ch = filehandle.peek();	
		
		if(ch == '('){
			n = numLeaves;  //number of leaves / sequences, we want node 1 to start where the leaves left off

			lc = readNewickInt(filehandle, n, T, ct);
			if (lc == -1) { m->mothurOut("error with lc"); m->mothurOutEndLine(); m->control_pressed = true; return -1; } //reports an error in reading
	
			if(filehandle.peek()==','){							
				readSpecialChar(filehandle,',',"comma");
			}
			// ';' means end of tree.												
			else if((ch=filehandle.peek())==';' || ch=='['){		
				rooted = 1;									
			}	
		
			if(rooted != 1){								
				rc = readNewickInt(filehandle, n, T, ct);
				if (rc == -1) { m->mothurOut("error with rc"); m->mothurOutEndLine(); m->control_pressed = true; return -1; } //reports an error in reading
				if(filehandle.peek() == ')'){					
					readSpecialChar(filehandle,')',"right parenthesis");
				}											
			}	
		}
		//note: treeclimber had the code below added - not sure why?
		else{
			filehandle.putback(ch);
			char name[MAX_LINE];
			filehandle.get(name, MAX_LINE,'\n');
			SKIPLINE(filehandle, ch);
		
			n = T->getIndex(name);

			if(n!=0){
				m->mothurOut("Internal error: The only taxon is not taxon 0.\n");
				//exit(1);
				readOk = -1; return -1;
			}
			lc = rc = -1;
		} 
		
		while(((ch=filehandle.get())!=';') && (filehandle.eof() != true)){;}  	
							
		if(rooted != 1){									
			T->tree[n].setChildren(lc,rc);
			T->tree[n].setBranchLength(0);
			T->tree[n].setParent(-1);
			if(lc!=-1){		T->tree[lc].setParent(n);		}
			if(rc!=-1){		T->tree[rc].setParent(n);		}
		}
		
		//T->printTree(); cout << endl;
		return 0;
	
	}
	catch(exception& e) {
		m->errorOut(e, "ReadNewickTree", "readTreeString");
		exit(1);
	}
}
/**************************************************************************************************/

int ReadNewickTree::readNewickInt(istream& f, int& n, Tree* T, CountTable* ct) {
	try {
		
		if (m->control_pressed) { return -1; } 
		
		int c = readNodeChar(f);

		if(c == '('){
		
			//to account for multifurcating trees generated by fasttree, we are forcing them to be bifurcating
			//read all children
			vector<int> childrenNodes;
			while(f.peek() != ')'){
				int child = readNewickInt(f, n, T, ct);
				if (child == -1) { return -1; } //reports an error in reading
		//cout << "child = " << child << endl;		
				childrenNodes.push_back(child);
				
				//after a child you either have , or ), check for both
				if(f.peek()==')'){  break;  }
				else if (f.peek()==',') {   readSpecialChar(f,',',"comma");  }
				else {;}
			}
	//cout << childrenNodes.size() << endl;		
			if (childrenNodes.size() < 2) {  m->mothurOut("Error in tree, please correct."); m->mothurOutEndLine(); return -1; }
			
			//then force into 2 node structure
			for (int i = 1; i < childrenNodes.size(); i++) {
			
				int lc, rc;
				if (i == 1) { lc = childrenNodes[i-1]; rc = childrenNodes[i]; }
				else { lc = n-1; rc = childrenNodes[i]; }
			//cout << i << '\t' << lc << '\t' << rc << endl;	
				T->tree[n].setChildren(lc,rc);
				T->tree[lc].setParent(n);
				T->tree[rc].setParent(n);
				
				//T->printTree(); cout << endl;
				n++;
			}
			
			//to account for extra ++ in looping
			n--;
			
			if(f.peek()==')'){	
				readSpecialChar(f,')',"right parenthesis");	
				//to pass over labels in trees
				c=filehandle.get();
				while((c!=',') && (c != -1) && (c!= ':') && (c!=';')&& (c!=')')){ c=filehandle.get(); }
				filehandle.putback(c);
			}			
		
			if(f.peek() == ':'){									      
				readSpecialChar(f,':',"colon");	
										
				if(n >= numNodes){ m->mothurOut("Error: Too many nodes in input tree\n");  readOk = -1; return -1; }
				
				T->tree[n].setBranchLength(readBranchLength(f));
			}else{
				T->tree[n].setBranchLength(0.0); 
			}						
						
			return n++;
		
		}else{
			f.putback(c);
			string name = "";
			char d=f.get();
			while(d != ':' && d != ',' && d!=')' && d!='\n'){					
				name += d;
				d=f.get();
			}
//cout << name << endl;
			int blen = 0;
			if(d == ':')	{		blen = 1;	}		
		
			f.putback(d);
		
			//set group info
			vector<string> group = ct->getGroups(name);
            //cout << name << endl;	
			//find index in tree of name
			int n1 = T->getIndex(name);
			
			//adds sequence names that are not in group file to the "xxx" group
			if(group.size() == 0) {
				m->mothurOut("Name: " + name + " is not in your groupfile, and will be disregarded. \n");  //readOk = -1; return n1;
				
                vector<string> currentGroups = ct->getNamesOfGroups();
                if (!m->inUsersGroups("xxx", currentGroups)) {  ct->addGroup("xxx");  }
                currentGroups = ct->getNamesOfGroups();
                vector<int> thisCounts; thisCounts.resize(currentGroups.size(), 0);
                for (int h = 0; h < currentGroups.size(); h++) {  
                    if (currentGroups[h] == "xxx") {  thisCounts[h] = 1;  break; }
                }
                ct->push_back(name, thisCounts);
                
				group.push_back("xxx");
			}			
			T->tree[n1].setGroup(group);
			T->tree[n1].setChildren(-1,-1);
		
			if(blen == 1){	
				f.get();
				T->tree[n1].setBranchLength(readBranchLength(f));
			}else{
				T->tree[n1].setBranchLength(0.0);
			}
		
			while((c=f.get())!=0 && (c != ':' && c != ',' && c!=')') )		{;}		
	
			f.putback(c);
		
			return n1;
		}
	}
	catch(exception& e) {
		m->errorOut(e, "ReadNewickTree", "readNewickInt");
		exit(1);
	}
}
/**************************************************************************************************/
/**************************************************************************************************/