]> git.donarmstrong.com Git - mothur.git/blob - slayer.cpp
removed some of the warning output from chimera.slayer
[mothur.git] / slayer.cpp
1 /*
2  *  slayer.cpp
3  *  Mothur
4  *
5  *  Created by westcott on 9/25/09.
6  *  Copyright 2009 Schloss Lab. All rights reserved.
7  *
8  */
9
10 #include "slayer.h"
11
12 /***********************************************************************/
13 Slayer::Slayer(int win, int increment, int parentThreshold, float div, int i, int snp) :
14                 windowSize(win), windowStep(increment), parentFragmentThreshold(parentThreshold), divRThreshold(div), iters(i), percentSNPSample(snp){ m = MothurOut::getInstance(); }
15 /***********************************************************************/
16 string Slayer::getResults(Sequence* query, vector<Sequence*> refSeqs) {
17         try {
18                 vector<data_struct> all; all.clear();
19                 
20                 for (int i = 0; i < refSeqs.size(); i++) {
21                 
22                         for (int j = i+1; j < refSeqs.size(); j++) {
23                         
24                                 if (m->control_pressed) { return "no";  }
25         
26                                 //make copies of query and each parent because runBellerophon removes gaps and messes them up
27                                 Sequence* q = new Sequence(query->getName(), query->getAligned());
28                                 Sequence* leftParent = new Sequence(refSeqs[i]->getName(), refSeqs[i]->getAligned());
29                                 Sequence* rightParent = new Sequence(refSeqs[j]->getName(), refSeqs[j]->getAligned());
30
31                                 map<int, int> spots;  //map from spot in original sequence to spot in filtered sequence for query and both parents
32                                 vector<data_struct> divs = runBellerophon(q, leftParent, rightParent, spots);
33                                 
34                                 if (m->control_pressed) { 
35                                         delete q;
36                                         delete leftParent;
37                                         delete rightParent;
38                                         return "no"; 
39                                 }
40                                         
41                                 vector<data_struct> selectedDivs;
42                                 for (int k = 0; k < divs.size(); k++) {
43                                         
44                                         vector<snps> snpsLeft = getSNPS(divs[k].parentA.getAligned(), divs[k].querySeq.getAligned(), divs[k].parentB.getAligned(), divs[k].winLStart, divs[k].winLEnd);
45                                         vector<snps> snpsRight = getSNPS(divs[k].parentA.getAligned(), divs[k].querySeq.getAligned(), divs[k].parentB.getAligned(), divs[k].winRStart, divs[k].winREnd);
46                                         
47                                         if (m->control_pressed) { 
48                                                 delete q;
49                                                 delete leftParent;
50                                                 delete rightParent;
51                                                 return "no"; 
52                                         }
53                                         
54                                         int numSNPSLeft = snpsLeft.size();
55                                         int numSNPSRight = snpsRight.size();
56                                         
57                                         //require at least 3 SNPs on each side of the break
58                                         if ((numSNPSLeft >= 3) && (numSNPSRight >= 3)) {
59                                         
60                                                 //removed in 12/09 version of chimeraSlayer
61                                                 //int winSizeLeft = divs[k].winLEnd - divs[k].winLStart + 1;
62                                                 //int winSizeRight = divs[k].winREnd - divs[k].winRStart + 1;
63                                                 
64                                                 //float snpRateLeft = numSNPSLeft / (float) winSizeLeft;
65                                                 //float snpRateRight = numSNPSRight / (float) winSizeRight;
66                                                 //float logR = log(snpRateLeft / snpRateRight) / log(2.0); 
67                                                 
68                                                 // do not accept excess snp ratio on either side of the break
69                                                 //if (abs(logR) < 1 ) {  
70                                                         
71                                                         float BS_A, BS_B;
72                                                         bootstrapSNPS(snpsLeft, snpsRight, BS_A, BS_B);
73                                                         
74                                                         if (m->control_pressed) { 
75                                                                 delete q;
76                                                                 delete leftParent;
77                                                                 delete rightParent;
78                                                                 return "no"; 
79                                                         }
80
81                                                         divs[k].bsa = BS_A;
82                                                         divs[k].bsb = BS_B;
83                                                 
84                                                         divs[k].bsMax = max(BS_A, BS_B);
85                                                 
86                                                         divs[k].chimeraMax = max(divs[k].qla_qrb, divs[k].qlb_qra);
87                                                         
88                                                         //so results reflect orignal alignment
89                                                         divs[k].winLStart = spots[divs[k].winLStart];
90                                                         divs[k].winLEnd = spots[divs[k].winLEnd];  
91                                                         divs[k].winRStart = spots[divs[k].winRStart]; 
92                                                         divs[k].winREnd = spots[divs[k].winREnd]; 
93                                                 
94                                                         selectedDivs.push_back(divs[k]);
95                                                 //}
96                                         }
97                                 }
98                                 
99                                 //save selected
100                                 for (int m = 0; m < selectedDivs.size(); m++) {  all.push_back(selectedDivs[m]);        }
101                                 
102                                 delete q;
103                                 delete leftParent;
104                                 delete rightParent;
105                         }
106                 }
107                 
108                 // compute bootstrap support
109                 if (all.size() > 0) {
110                         //sort them
111                         sort(all.begin(), all.end(), compareDataStruct);
112                         reverse(all.begin(), all.end());
113                         
114                         outputResults = all;
115                         return "yes"; 
116                 }
117                 else {
118                         outputResults = all;
119                         return "no";
120                 }
121         }
122         catch(exception& e) {
123                 m->errorOut(e, "Slayer", "getResults");
124                 exit(1);
125         }
126 }
127 /***********************************************************************/
128 vector<data_struct> Slayer::runBellerophon(Sequence* q, Sequence* pA, Sequence* pB, map<int, int>& spots) {
129         try{
130                 
131                 vector<data_struct> data;
132                 
133                 //vertical filter
134                 vector<Sequence*> temp;
135                 temp.push_back(q); temp.push_back(pA); temp.push_back(pB);
136                 
137                 //maps spot in new alignment to spot in alignment before filter
138                 spots = verticalFilter(temp);  //fills baseSpots
139                 
140                 //get these to avoid numerous function calls
141                 string query = q->getAligned();
142                 string parentA = pA->getAligned();
143                 string parentB = pB->getAligned();
144                 int length = query.length();
145 /*cout << q->getName() << endl << q->getAligned() << endl << endl;      
146 cout << pA->getName() << endl << pA->getAligned() << endl << endl;              
147 cout << pB->getName() << endl << pB->getAligned() << endl << endl;      
148 cout << " length = " << length << endl;
149 cout << q->getName() << endl;
150 cout << pA->getName() << '\t';
151 cout << pB->getName() << endl;*/
152         
153                 //check window size
154                 if (length < (2*windowSize+windowStep)) { 
155 //                      m->mothurOut("Your window size is too large for " + q->getName() + ". I will make the window size " + toString(length/4) + " which is 1/4 the filtered length."); m->mothurOutEndLine();        
156                         windowSize = length / 4;
157                 }
158                 
159                 for (int i = windowSize-1; i <= (length - windowSize); i += windowStep) {
160                 
161                         if (m->control_pressed) { return data; }
162                 
163                         int breakpoint = i;
164                         int leftLength = breakpoint + 1;
165                         int rightLength = length - leftLength;
166                         
167                         float QLA = computePercentID(query, parentA, 0, breakpoint);
168                         float QRB = computePercentID(query, parentB, breakpoint+1, length - 1);
169                 
170                         float QLB = computePercentID(query, parentB, 0, breakpoint);
171                         float QRA = computePercentID(query, parentA, breakpoint+1, length - 1);
172                 
173                         float LAB = computePercentID(parentA, parentB, 0, breakpoint);
174                         float RAB = computePercentID(parentA, parentB, breakpoint+1, length - 1);
175                 
176                         float AB = ((LAB*leftLength) + (RAB*rightLength)) / (float) length;
177                         float QA = ((QLA*leftLength) + (QRA*rightLength)) / (float) length;
178                         float QB = ((QLB*leftLength) + (QRB*rightLength)) / (float) length;
179                 
180                         float QLA_QRB = ((QLA*leftLength) + (QRB*rightLength)) / (float) length;
181                         float QLB_QRA = ((QLB*leftLength) + (QRA*rightLength)) / (float) length;
182                 
183                         //in original and not used
184                         //float avgQA_QB = ((QA*leftLength) + (QB*rightLength)) / (float) length;
185                 
186                         float divR_QLA_QRB = min((QLA_QRB/QA), (QLA_QRB/QB));
187                         float divR_QLB_QRA = min((QLB_QRA/QA), (QLB_QRA/QB));
188 //cout << leftLength << '\t' << rightLength << '\t' << QLA << '\t' << QRB << '\t' << QLB << '\t' << QRA  << '\t' << LAB << '\t' << RAB << '\t' << AB << '\t' << QA << '\t' << QB << '\t' << QLA_QRB << '\t' <<  QLB_QRA <<    endl;             
189
190 //cout << divRThreshold << endl;
191 //cout << breakpoint << '\t' << divR_QLA_QRB << '\t' << divR_QLB_QRA << endl;
192                         //is one of them above the 
193                         if (divR_QLA_QRB >= divRThreshold || divR_QLB_QRA >= divRThreshold) {
194                                 
195                                 if (((QLA_QRB > QA) && (QLA_QRB > QB) && (QLA >= parentFragmentThreshold) && (QRB >= parentFragmentThreshold))  ||
196                                         ((QLB_QRA > QA) && (QLB_QRA > QB) && (QLB >=parentFragmentThreshold) && (QRA >= parentFragmentThreshold)))  {
197                                         
198                                         data_struct member;
199                                         
200                                         member.divr_qla_qrb = divR_QLA_QRB;
201                                         member.divr_qlb_qra = divR_QLB_QRA;
202                                         member.qla_qrb = QLA_QRB;
203                                         member.qlb_qra = QLB_QRA;
204                                         member.qla = QLA;
205                                         member.qrb = QRB;
206                                         member.ab = AB; 
207                                         member.qa = QA;
208                                         member.qb = QB; 
209                                         member.lab = LAB; 
210                                         member.rab = RAB; 
211                                         member.qra = QRA; 
212                                         member.qlb = QLB; 
213                                         member.winLStart = 0;
214                                         member.winLEnd = breakpoint;  
215                                         member.winRStart = breakpoint+1; 
216                                         member.winREnd = length-1; 
217                                         member.querySeq = *(q); 
218                                         member.parentA = *(pA);
219                                         member.parentB = *(pB);
220                                         member.bsa = 0;
221                                         member.bsb = 0;
222                                         member.bsMax = 0;
223                                         member.chimeraMax = 0;
224                                         
225                                         data.push_back(member);
226                                         
227                                 }//if
228                         }//if
229                 }//for
230                 
231                 return data;
232                 
233         }
234         catch(exception& e) {
235                 m->errorOut(e, "Slayer", "runBellerophon");
236                 exit(1);
237         }
238 }
239 /***********************************************************************/
240 vector<snps> Slayer::getSNPS(string parentA, string query, string parentB, int left, int right) {
241         try {
242         
243                 vector<snps> data;
244 //cout << left << '\t' << right << endl;
245                 for (int i = left; i <= right; i++) {
246                         
247                         char A = parentA[i];
248                         char Q = query[i];
249                         char B = parentB[i];
250                         
251                         if ((A != Q) || (B != Q)) {
252 //cout << "not equal " << Q << '\t' << A << '\t' << B << endl;
253                         
254                                 //ensure not neighboring a gap. change to 12/09 release of chimeraSlayer - not sure what this adds, but it eliminates alot of SNPS
255                                 if (
256                                         //did query loose a base here during filter??
257                                         ( i == 0 || abs (baseSpots[0][i] - baseSpots[0][i-1]) == 1) &&
258                                         ( i == query.length() || abs (baseSpots[0][i] - baseSpots[0][i+1]) == 1)
259                                         &&
260                                         //did parentA loose a base here during filter??
261                                         ( i == 0 || abs (baseSpots[1][i] - baseSpots[1][i-1]) == 1) &&
262                                         ( i == parentA.length() || abs (baseSpots[1][i] - baseSpots[1][i+1]) == 1) 
263                                         &&
264                                         //did parentB loose a base here during filter??
265                                         ( i == 0 || abs (baseSpots[2][i] - baseSpots[2][i-1]) == 1) &&
266                                         ( i == parentB.length() || abs (baseSpots[2][i] - baseSpots[2][i+1]) == 1)
267                                         ) 
268                                 { 
269                                 
270                                         snps member;
271                                         member.queryChar = Q;
272                                         member.parentAChar = A;
273                                         member.parentBChar = B;
274 //cout << "not neighboring a gap " << Q << '\t' << A << '\t' << B << '\t' << baseSpots[0][i] << '\t' << baseSpots[0][i+1] << '\t' << baseSpots[0][i-1] << '\t' << baseSpots[1][i] << '\t' << baseSpots[1][i+1] << '\t' << baseSpots[1][i-1] << '\t' << baseSpots[2][i] << '\t' << baseSpots[2][i+1] << '\t' << baseSpots[2][i-1] << endl;                               
275                                         data.push_back(member);
276                                 }
277                         }
278                 }
279                 
280                 return data;
281                 
282         }
283         catch(exception& e) {
284                 m->errorOut(e, "Slayer", "getSNPS");
285                 exit(1);
286         }
287 }
288 /***********************************************************************/
289 int Slayer::bootstrapSNPS(vector<snps> left, vector<snps> right, float& BSA, float& BSB) {
290         try {
291
292                 srand((unsigned)time( NULL ));
293
294                 int count_A = 0; // sceneario QLA,QRB supported
295                 int count_B = 0; // sceneario QLB,QRA supported
296         
297                 int numLeft = max(1, int(left.size() * (percentSNPSample/(float)100) + 0.5));
298                 int numRight = max(1, int(right.size() * (percentSNPSample/(float)100) + 0.5));
299
300                 for (int i = 0; i < iters; i++) {
301                         //random sampling with replacement.
302                 
303                         if (m->control_pressed) { return 0;  }
304                         
305                         vector<snps> selectedLeft;
306
307                         for (int j = 0; j < numLeft; j++) {
308                                 int index = int(rand() % left.size());
309                                 selectedLeft.push_back(left[index]);
310                         }
311
312                         vector<snps> selectedRight;
313                         for (int j = 0; j < numRight; j++) {
314                                 int index = int(rand() % right.size());
315                                 selectedRight.push_back(right[index]);
316                         }
317                 
318                         /* A  ------------------------------------------
319                         #       QLA                     QRA
320                         # Q  ------------------------------------------
321                         #                      |
322                         #                      |
323                         # Q  ------------------------------------------
324                         #       QLB                     QRB
325                         # B  ------------------------------------------ */
326                 
327                 
328                         float QLA = snpQA(selectedLeft);
329                         float QRA = snpQA(selectedRight);
330                 
331                         float QLB = snpQB(selectedLeft);
332                         float QRB = snpQB(selectedRight);
333         
334                         //in original - not used - not sure why?
335                         //float ALB = snpAB(selectedLeft);
336                         //float ARB = snpAB(selectedRight);
337                 
338                         if ((QLA > QLB) && (QRB > QRA)) {
339                                 count_A++;
340                         }
341                 
342                         if ((QLB > QLA) && (QRA > QRB)) {
343                                 count_B++;
344                         }
345                         
346 //cout << "selected left snp: \n";
347 //for (int j = 0; j < selectedLeft.size(); j++) {  cout << selectedLeft[j].parentAChar;  } 
348 //cout << endl;
349 //for (int j = 0; j < selectedLeft.size(); j++) {  cout << selectedLeft[j].queryChar;  }
350 //cout << endl;
351 //for (int j = 0; j < selectedLeft.size(); j++) {  cout << selectedLeft[j].parentBChar;  }
352 //cout << endl;
353 //cout << "selected right snp: \n";
354 //for (int j = 0; j < selectedRight.size(); j++) {  cout << selectedRight[j].parentAChar;  } 
355 //cout << endl;
356 //for (int i = 0; i < selectedRight.size(); i++) {  cout << selectedRight[i].queryChar;  }
357 //cout << endl;
358 //for (int i = 0; i < selectedRight.size(); i++) {  cout << selectedRight[i].parentBChar;  }
359 //cout << endl;         
360                 }
361
362
363
364
365                 BSA = ((float) count_A / (float) iters) * 100;
366                 BSB = ((float) count_B / (float) iters) * 100;
367 //cout << "bsa = " << BSA << " bsb = " << BSB << endl;
368
369                 return 0;
370         
371         }
372         catch(exception& e) {
373                 m->errorOut(e, "Slayer", "bootstrapSNPS");
374                 exit(1);
375         }
376 }
377 /***********************************************************************/
378 float Slayer::snpQA(vector<snps> data) {
379         try {
380         
381                 int numIdentical = 0;
382         
383                 for (int i = 0; i < data.size(); i++) {
384                         if (data[i].parentAChar == data[i].queryChar) {
385                                 numIdentical++;
386                         }
387                 }
388
389                 float percentID = (numIdentical / (float) data.size()) * 100;
390                 
391                 return percentID;
392         }
393         catch(exception& e) {
394                 m->errorOut(e, "Slayer", "snpQA");
395                 exit(1);
396         }
397 }
398 /***********************************************************************/
399 float Slayer::snpQB(vector<snps> data) {
400         try {
401         
402                 int numIdentical = 0;
403         
404                 for (int i = 0; i < data.size(); i++) {
405                         if (data[i].parentBChar == data[i].queryChar) {
406                                 numIdentical++;
407                         }
408                 }
409
410                 float percentID = (numIdentical / (float) data.size()) * 100;
411                 
412                 return percentID;
413
414         }
415         catch(exception& e) {
416                 m->errorOut(e, "Slayer", "snpQB");
417                 exit(1);
418         }
419 }
420 /***********************************************************************/
421 float Slayer::snpAB(vector<snps> data) {
422         try {
423                 int numIdentical = 0;
424         
425                 for (int i = 0; i < data.size(); i++) {
426                         if (data[i].parentAChar == data[i].parentBChar) {
427                                 numIdentical++;
428                         }
429                 }
430
431                 float percentID = (numIdentical / (float) data.size()) * 100;
432                 
433                 return percentID;
434
435         }
436         catch(exception& e) {
437                 m->errorOut(e, "Slayer", "snpAB");
438                 exit(1);
439         }
440 }
441 /***********************************************************************/
442 float Slayer::computePercentID(string queryFrag, string parent, int left, int right) {
443         try {
444                 int total = 0;
445                 int matches = 0;
446
447                 for (int i = left; i <= right; i++) {
448                         total++;
449                         if (queryFrag[i] == parent[i]) {
450                                 matches++;
451                         }
452                 }
453
454                 float percentID =( matches/(float)total) * 100;
455                 
456                 return percentID;
457         }
458         catch(exception& e) {
459                 m->errorOut(e, "Slayer", "computePercentID");
460                 exit(1);
461         }
462 }
463 /***********************************************************************/
464 //remove columns that contain any gaps
465 map<int, int> Slayer::verticalFilter(vector<Sequence*> seqs) {
466         try {
467                 //find baseSpots
468                 baseSpots.clear(); 
469                 baseSpots.resize(3);  //query, parentA, parentB
470         
471                 vector<int> gaps;       gaps.resize(seqs[0]->getAligned().length(), 0);
472                 
473                 string filterString = (string(seqs[0]->getAligned().length(), '1'));
474                 
475                 //for each sequence
476                 for (int i = 0; i < seqs.size(); i++) {
477                 
478                         string seqAligned = seqs[i]->getAligned();
479                         
480                         for (int j = 0; j < seqAligned.length(); j++) {
481                                 //if this spot is a gap
482                                 if ((seqAligned[j] == '-') || (seqAligned[j] == '.') || (toupper(seqAligned[j]) == 'N'))        {   gaps[j]++;  }
483                         }
484                 }
485                 
486                 //zero out spot where any sequences have blanks
487                 int numColRemoved = 0;
488                 int count = 0;
489                 map<int, int> maskMap; maskMap.clear();
490
491                 for(int i = 0; i < seqs[0]->getAligned().length(); i++){
492                         if(gaps[i] != 0)        {       filterString[i] = '0';  numColRemoved++;  }
493                         else {
494                                 maskMap[count] = i;
495                                 count++;
496                         }
497                 }
498
499                 //for each sequence
500                 for (int i = 0; i < seqs.size(); i++) {
501                 
502                         string seqAligned = seqs[i]->getAligned();
503                         string newAligned = "";
504                         
505                         int baseCount = 0;
506                         int count = 0;
507                         for (int j = 0; j < seqAligned.length(); j++) {
508                                 //are you a base
509                                 if ((seqAligned[j] != '-') && (seqAligned[j] != '.') && (toupper(seqAligned[j]) != 'N'))        { baseCount++; }
510                         
511                                 //if this spot is not a gap
512                                 if (filterString[j] == '1') { 
513                                         newAligned += seqAligned[j]; 
514                                         baseSpots[i][count] = baseCount;
515                                         count++;
516                                 }
517                         }
518                         
519                         seqs[i]->setAligned(newAligned);
520                 }
521                 
522                 return maskMap;
523         }
524         catch(exception& e) {
525                 m->errorOut(e, "Slayer", "verticalFilter");
526                 exit(1);
527         }
528 }
529 /***********************************************************************/