5 * Created by Sarah Westcott on 7/22/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
12 //***************************************************************************************************************
13 void DeCalculator::setMask(string m) {
17 if (seqMask.length() != 0) {
18 //whereever there is a base in the mask, save that value is query and subject
19 for (int i = 0; i < seqMask.length(); i++) {
20 if (isalpha(seqMask[i])) {
25 for (int i = 0; i < alignLength; i++) { h.insert(i); }
29 errorOut(e, "DeCalculator", "setMask");
33 //***************************************************************************************************************
34 void DeCalculator::runMask(Sequence* seq) {
37 string q = seq->getAligned();
38 string tempQuery = "";
40 //whereever there is a base in the mask, save that value is query and subject
41 set<int>::iterator setit;
42 for ( setit=h.begin() ; setit != h.end(); setit++ ) {
43 tempQuery += q[*setit];
47 seq->setAligned(tempQuery);
48 seq->setUnaligned(tempQuery);
51 errorOut(e, "DeCalculator", "runMask");
55 //***************************************************************************************************************
56 //num is query's spot in querySeqs
57 void DeCalculator::trimSeqs(Sequence* query, Sequence* subject, map<int, int>& trim) {
60 string q = query->getAligned();
61 string s = subject->getAligned();
64 for (int i = 0; i < q.length(); i++) {
65 //cout << "query = " << q[i] << " subject = " << s[i] << endl;
66 if (isalpha(q[i]) && isalpha(s[i])) { front = i; break; }
68 //cout << endl << endl;
70 for (int i = q.length(); i >= 0; i--) {
71 //cout << "query = " << q[i] << " subject = " << s[i] << endl;
72 if (isalpha(q[i]) && isalpha(s[i])) { back = i; break; }
79 errorOut(e, "DeCalculator", "trimSeqs");
83 //***************************************************************************************************************
84 vector<int> DeCalculator::findWindows(Sequence* query, int front, int back, int& size, int increment) {
89 int cutoff = back - front; //back - front
91 //if window is set to default
92 if (size == 0) { if (cutoff > 1200) { size = 300; }
93 else{ size = (cutoff / 4); } }
94 else if (size > (cutoff / 4)) {
95 mothurOut("You have selected to large a window size for sequence " + query->getName() + ". I will choose an appropriate window size."); mothurOutEndLine();
99 /* string seq = query->getAligned().substr(front, cutoff);
103 for (int l = 0; l < seq.length(); l++) { if (isalpha(seq[l])) { numBases++; } }
104 //cout << "num Bases = " << numBases << endl;
106 win.push_back(front);
107 //cout << front << '\t';
108 //move ahead increment bases at a time until all bases are in a window
110 int totalBases = 0; //used to eliminate window of blanks at end of sequence
112 seq = query->getAligned();
113 for (int m = front; m < (back - size) ; m++) {
115 //count number of bases you see
116 if (isalpha(seq[m])) { countBases++; }
118 //if you have seen enough bases to make a new window
119 if (countBases >= increment) {
120 //total bases is the number of bases in a window already.
121 totalBases += countBases;
122 //cout << "total bases = " << totalBases << endl;
123 win.push_back(m); //save spot in alignment
125 countBases = 0; //reset bases you've seen in this window
128 //no need to continue if all your bases are in a window
129 if (totalBases == numBases) { break; }
133 //get last window if needed
134 if (totalBases < numBases) { win.push_back(back-size); }
135 //cout << endl << endl;
138 //this follows wigeon, but we may want to consider that it chops off the end values if the sequence cannot be evenly divided into steps
139 for (int m = front; m < (back - size) ; m+=increment) { win.push_back(m); }
146 catch(exception& e) {
147 errorOut(e, "DeCalculator", "findWindows");
152 //***************************************************************************************************************
153 vector<float> DeCalculator::calcObserved(Sequence* query, Sequence* subject, vector<int> window, int size) {
158 for (int m = 0; m < window.size(); m++) {
160 string seqFrag = query->getAligned().substr(window[m], size);
161 string seqFragsub = subject->getAligned().substr(window[m], size);
164 for (int b = 0; b < seqFrag.length(); b++) {
165 //if at least one is a base and they are not equal
166 if( (isalpha(seqFrag[b]) || isalpha(seqFragsub[b])) && (seqFrag[b] != seqFragsub[b]) ) { diff++; }
169 //percentage of mismatched bases
172 //if the whole fragment is 0 distance = 0
174 dist = diff / (float) (seqFrag.length()) * 100;
176 temp.push_back(dist);
181 catch(exception& e) {
182 errorOut(e, "DeCalculator", "calcObserved");
186 //***************************************************************************************************************
187 float DeCalculator::calcDist(Sequence* query, Sequence* subject, int front, int back) {
190 //so you only look at the trimmed part of the sequence
191 int cutoff = back - front;
194 //from first startpoint with length back-front
195 string seqFrag = query->getAligned().substr(front, cutoff);
196 string seqFragsub = subject->getAligned().substr(front, cutoff);
199 for (int b = 0; b < seqFrag.length(); b++) {
201 if((!isalpha(seqFrag[b])) && (!isalpha(seqFragsub[b]))) { gaps++; }
202 if (seqFrag[b] != seqFragsub[b]) { diff++; }
205 //if the whole fragment is 0 distance = 0
206 if ((seqFrag.length()-gaps) == 0) { return 0.0; }
208 //percentage of mismatched bases
209 float dist = diff / (float) (seqFrag.length()-gaps) * 100;
213 catch(exception& e) {
214 errorOut(e, "DeCalculator", "calcDist");
219 //***************************************************************************************************************
220 vector<float> DeCalculator::calcExpected(vector<float> qav, float coef) {
224 vector<float> queryExpected;
226 for (int m = 0; m < qav.size(); m++) {
228 float expected = qav[m] * coef;
230 queryExpected.push_back(expected);
233 return queryExpected;
236 catch(exception& e) {
237 errorOut(e, "DeCalculator", "calcExpected");
241 //***************************************************************************************************************
242 float DeCalculator::calcDE(vector<float> obs, vector<float> exp) {
246 float sum = 0.0; //sum = sum from 1 to m of (oi-ei)^2
247 for (int m = 0; m < obs.size(); m++) { sum += ((obs[m] - exp[m]) * (obs[m] - exp[m])); }
249 float de = sqrt((sum / (obs.size() - 1)));
253 catch(exception& e) {
254 errorOut(e, "DeCalculator", "calcDE");
259 //***************************************************************************************************************
261 vector<float> DeCalculator::calcFreq(vector<Sequence*> seqs, string filename) {
265 string freqfile = getRootName(filename) + "freq";
268 openOutputFile(freqfile, outFreq);
270 string length = toString(seqs.size()); //if there are 5000 seqs in the template then set precision to 3
271 int precision = length.length() - 1;
274 outFreq.setf(ios::fixed, ios::floatfield); outFreq.setf(ios::showpoint);
276 //at each position in the sequence
277 for (int i = 0; i < seqs[0]->getAligned().length(); i++) {
279 vector<int> freq; freq.resize(4,0);
282 //find the frequency of each nucleotide
283 for (int j = 0; j < seqs.size(); j++) {
285 char value = seqs[j]->getAligned()[i];
287 if(toupper(value) == 'A') { freq[0]++; }
288 else if(toupper(value) == 'T' || toupper(value) == 'U') { freq[1]++; }
289 else if(toupper(value) == 'G') { freq[2]++; }
290 else if(toupper(value) == 'C') { freq[3]++; }
294 //find base with highest frequency
296 for (int m = 0; m < freq.size(); m++) { if (freq[m] > highest) { highest = freq[m]; } }
298 float highFreq = highest / (float) (seqs.size());
301 Pi = (highFreq - 0.25) / 0.75;
303 //cannot have probability less than 0.
304 if (Pi < 0) { Pi = 0.0; }
306 //saves this for later
307 outFreq << setprecision(precision) << i << '\t' << highFreq << endl;
309 if (h.count(i) > 0) {
319 catch(exception& e) {
320 errorOut(e, "DeCalculator", "calcFreq");
324 //***************************************************************************************************************
325 vector<float> DeCalculator::findQav(vector<int> window, int size, vector<float> probabilityProfile) {
327 vector<float> averages;
329 //for each window find average
330 for (int m = 0; m < window.size(); m++) {
334 //while you are in the window for this sequence
336 for (int j = window[m]; j < (window[m]+size); j++) {
337 average += probabilityProfile[j];
341 average = average / count;
343 //save this windows average
344 averages.push_back(average);
349 catch(exception& e) {
350 errorOut(e, "DeCalculator", "findQav");
354 //********************************************************************************************************************
355 //sorts lowest to highest
356 inline bool compareQuanMembers(quanMember left, quanMember right){
357 return (left.score < right.score);
359 //***************************************************************************************************************
360 //seqs have already been masked
361 vector< vector<quanMember> > DeCalculator::getQuantiles(vector<Sequence*> seqs, vector<int> windowSizesTemplate, int window, vector<float> probProfile, int increment, int start, int end, vector<float>& highestDE) {
363 vector< vector<quanMember> > quan;
365 //percentage of mismatched pairs 1 to 100
369 for(int i = start; i < end; i++){
371 mothurOut("Processing template sequence " + toString(i)); mothurOutEndLine();
372 Sequence* query = new Sequence(seqs[i]->getName(), seqs[i]->getAligned());
374 //compare to every other sequence in template
375 for(int j = 0; j < i; j++){
377 Sequence* subject = new Sequence(seqs[j]->getName(), seqs[j]->getAligned());
380 map<int, int>::iterator it;
382 trimSeqs(query, subject, trim);
385 int front = it->first; int back = it->second;
387 //reset window for each new comparison
388 windowSizesTemplate[i] = window;
390 vector<int> win = findWindows(query, front, back, windowSizesTemplate[i], increment);
392 vector<float> obsi = calcObserved(query, subject, win, windowSizesTemplate[i]);
394 vector<float> q = findQav(win, windowSizesTemplate[i], probProfile);
396 float alpha = getCoef(obsi, q);
398 vector<float> exp = calcExpected(q, alpha);
400 float de = calcDE(obsi, exp);
402 float dist = calcDist(query, subject, front, back);
406 quanMember newScore(de, i, j);
408 //dist-1 because vector indexes start at 0.
409 quan[dist-1].push_back(newScore);
412 if(de > highestDE[i]) { highestDE[i] = de; }
413 if(de > highestDE[j]) { highestDE[j] = de; }
426 catch(exception& e) {
427 errorOut(e, "DeCalculator", "findQav");
432 //***************************************************************************************************************
433 vector< vector<float> > DeCalculator::removeObviousOutliers(vector< vector<quanMember> >& quantiles, int num) {
435 vector< vector<float> > quan;
438 /*vector<quanMember> contributions;
439 vector<int> seen; //seen[0] is the number of outliers that template seqs[0] was part of.
443 for (int i = 0; i < quantiles.size(); i++) {
445 //find mean of this quantile score
446 sort(quantiles[i].begin(), quantiles[i].end(), compareQuanMembers);
448 float high = quantiles[i][int(quantiles[i].size() * 0.99)].score;
449 float low = quantiles[i][int(quantiles[i].size() * 0.01)].score;
451 //look at each value in quantiles to see if it is an outlier
452 for (int j = 0; j < quantiles[i].size(); j++) {
454 //is this score between 1 and 99%
455 if ((quantiles[i][j].score > low) && (quantiles[i][j].score < high)) {
458 //add to contributions
459 contributions.push_back(quantiles[i][j]);
460 seen[quantiles[i][j].member1]++;
461 seen[quantiles[i][j].member2]++;
466 //find contributer with most offending score related to it
467 int largestContrib = findLargestContrib(seen);
469 //while you still have guys to eliminate
470 while (contributions.size() > 0) {
472 mothurOut("Removing scores contributed by sequence " + toString(largestContrib) + " in your template file."); mothurOutEndLine();
474 //remove from quantiles all scores that were made using this largestContrib
475 for (int i = 0; i < quantiles.size(); i++) {
476 //cout << "before remove " << quantiles[i].size() << '\t';
477 removeContrib(largestContrib, quantiles[i]);
478 //cout << "after remove " << quantiles[i].size() << endl;
480 //cout << count << " largest contrib = " << largestContrib << endl; count++;
481 //remove from contributions all scores that were made using this largestContrib
482 removeContrib(largestContrib, contributions);
484 //"erase" largestContrib
485 seen[largestContrib] = -1;
487 //get next largestContrib
488 largestContrib = findLargestContrib(seen);
492 vector<int> marked = returnObviousOutliers(quantiles, num);
493 vector<int> copyMarked = marked;
495 //find the 99% of marked
496 sort(copyMarked.begin(), copyMarked.end());
497 int high = copyMarked[int(copyMarked.size() * 0.99)];
498 cout << "high = " << high << endl;
500 for(int i = 0; i < marked.size(); i++) {
501 if (marked[i] > high) {
502 mothurOut("Removing scores contributed by sequence " + toString(marked[i]) + " in your template file."); mothurOutEndLine();
503 for (int i = 0; i < quantiles.size(); i++) {
504 removeContrib(marked[i], quantiles[i]);
512 for (int i = 0; i < quantiles.size(); i++) {
515 if (quantiles[i].size() == 0) {
516 //in case this is not a distance found in your template files
517 for (int g = 0; g < 6; g++) {
522 sort(quantiles[i].begin(), quantiles[i].end(), compareQuanMembers);
525 temp.push_back(quantiles[i][int(quantiles[i].size() * 0.10)].score);
527 temp.push_back(quantiles[i][int(quantiles[i].size() * 0.25)].score);
529 temp.push_back(quantiles[i][int(quantiles[i].size() * 0.5)].score);
531 temp.push_back(quantiles[i][int(quantiles[i].size() * 0.75)].score);
533 temp.push_back(quantiles[i][int(quantiles[i].size() * 0.95)].score);
535 temp.push_back(quantiles[i][int(quantiles[i].size() * 0.99)].score);
545 catch(exception& e) {
546 errorOut(e, "DeCalculator", "removeObviousOutliers");
550 //***************************************************************************************************************
551 //follows Mallard algorythn in paper referenced from mallard class
552 vector<int> DeCalculator::returnObviousOutliers(vector< vector<quanMember> > quantiles, int num) {
554 vector< vector<float> > quan;
557 map<quanMember*, float> contributions; //map of quanMember to distance from high or low - how bad is it.
558 vector<int> marked; //marked[0] is the penalty of template seqs[0]. the higher the penalty the more likely the sequence is chimeric
559 marked.resize(num,0);
562 for (int i = 0; i < quantiles.size(); i++) {
564 //find mean of this quantile score
565 sort(quantiles[i].begin(), quantiles[i].end(), compareQuanMembers);
567 float high = quantiles[i][int(quantiles[i].size() * 0.99)].score;
568 float low = quantiles[i][int(quantiles[i].size() * 0.01)].score;
570 //look at each value in quantiles to see if it is an outlier
571 for (int j = 0; j < quantiles[i].size(); j++) {
573 //is this score between 1 and 99%
574 if ((quantiles[i][j].score > low) && (quantiles[i][j].score < high)) {
578 //add to contributions
579 if (quantiles[i][j].score < low) {
580 dist = low - quantiles[i][j].score;
581 contributions[&(quantiles[i][j])] = dist;
582 }else { //you are higher than high
583 dist = quantiles[i][j].score - high;
584 contributions[&(quantiles[i][j])] = dist;
590 //find contributer with most offending score related to it
591 vector<quanMember> outliers = sortContrib(contributions);
593 //go through the outliers marking the potential chimeras
594 for (int i = 0; i < outliers.size(); i++) {
596 //who is responsible for this outlying score?
597 //if member1 has greater score mark him
598 //if member2 has greater score mark her
599 //if they are the same mark both
600 if (marked[outliers[i].member1] > marked[outliers[i].member2]) { marked[outliers[i].member1]++; }
601 else if (marked[outliers[i].member2] > marked[outliers[i].member1]) { marked[outliers[i].member2]++; }
602 else if (marked[outliers[i].member2] == marked[outliers[i].member1]) { marked[outliers[i].member2]++; marked[outliers[i].member1]++; }
607 catch(exception& e) {
608 errorOut(e, "DeCalculator", "removeObviousOutliers");
612 //***************************************************************************************************************
613 vector<quanMember> DeCalculator::sortContrib(map<quanMember*, float> quan) {
616 vector<quanMember> newQuan;
617 map<quanMember*, float>::iterator it;
619 while (quan.size() > 0) {
621 map<quanMember*, float>::iterator largest = quan.begin();
623 //find biggest member
624 for (it = quan.begin(); it != quan.end(); it++) {
625 if (it->second > largest->second) { largest = it; }
629 newQuan.push_back(*(largest->first));
638 catch(exception& e) {
639 errorOut(e, "DeCalculator", "sortContrib");
644 //***************************************************************************************************************
645 int DeCalculator::findLargestContrib(vector<int> seen) {
652 for (int i = 0; i < seen.size(); i++) {
654 if (seen[i] > largest) {
660 return largestContribs;
663 catch(exception& e) {
664 errorOut(e, "DeCalculator", "findLargestContribs");
668 //***************************************************************************************************************
669 void DeCalculator::removeContrib(int bad, vector<quanMember>& quan) {
672 vector<quanMember> newQuan;
673 for (int i = 0; i < quan.size(); i++) {
674 if ((quan[i].member1 != bad) && (quan[i].member2 != bad) ) {
675 newQuan.push_back(quan[i]);
682 catch(exception& e) {
683 errorOut(e, "DeCalculator", "removeContrib");
688 //***************************************************************************************************************
689 float DeCalculator::findAverage(vector<float> myVector) {
693 for (int i = 0; i < myVector.size(); i++) { total += myVector[i]; }
695 float average = total / (float) myVector.size();
700 catch(exception& e) {
701 errorOut(e, "DeCalculator", "findAverage");
706 //***************************************************************************************************************
707 float DeCalculator::getCoef(vector<float> obs, vector<float> qav) {
710 //find average prob for this seqs windows
711 float probAverage = findAverage(qav);
713 //find observed average
714 float obsAverage = findAverage(obs);
716 float coef = obsAverage / probAverage;
720 catch(exception& e) {
721 errorOut(e, "DeCalculator", "getCoef");
725 //***************************************************************************************************************