5 * Created by westcott on 9/23/09.
6 * Copyright 2009 Schloss Lab. All rights reserved.
12 #include "blastdb.hpp"
14 /***********************************************************************/
15 Maligner::Maligner(vector<Sequence*> temp, int num, int match, int misMatch, float div, int ms, int minCov, string mode, Database* dataLeft, Database* dataRight) :
16 db(temp), numWanted(num), matchScore(match), misMatchPenalty(misMatch), minDivR(div), minSimilarity(ms), minCoverage(minCov), searchMethod(mode), databaseLeft(dataLeft), databaseRight(dataRight) {
19 m = MothurOut::getInstance();
21 // cout << matchScore << '\t' << misMatchPenalty << endl;
24 // misMatchPenalty = -1;
28 /***********************************************************************/
29 string Maligner::getResults(Sequence* q, DeCalculator* decalc) {
32 outputResults.clear();
34 //make copy so trimming doesn't destroy query from calling class - remember to deallocate
35 query = new Sequence(q->getName(), q->getAligned());
39 if (searchMethod == "distance") {
40 //find closest seqs to query in template - returns copies of seqs so trim does not destroy - remember to deallocate
41 refSeqs = decalc->findClosest(query, db, numWanted, indexes);
42 }else if (searchMethod == "blast") {
43 refSeqs = getBlastSeqs(query, numWanted); //fills indexes
44 }else if (searchMethod == "kmer") {
45 refSeqs = getKmerSeqs(query, numWanted); //fills indexes
46 }else { m->mothurOut("not valid search."); exit(1); } //should never get here
48 if (m->control_pressed) { return chimera; }
50 refSeqs = minCoverageFilter(refSeqs);
52 if (refSeqs.size() < 2) {
53 for (int i = 0; i < refSeqs.size(); i++) { delete refSeqs[i]; }
54 percentIdenticalQueryChimera = 0.0;
58 int chimeraPenalty = computeChimeraPenalty();
61 chimera = chimeraMaligner(chimeraPenalty, decalc);
63 if (m->control_pressed) { return chimera; }
68 for (int i = 0; i < refSeqs.size(); i++) { delete refSeqs[i]; }
73 m->errorOut(e, "Maligner", "getResults");
77 /***********************************************************************/
78 string Maligner::chimeraMaligner(int chimeraPenalty, DeCalculator* decalc) {
83 //trims seqs to first non gap char in all seqs and last non gap char in all seqs
84 spotMap = decalc->trimSeqs(query, refSeqs);
86 //you trimmed the whole sequence, skip
87 if (query->getAligned() == "") { return "no"; }
89 vector<Sequence*> temp = refSeqs;
90 temp.push_back(query);
94 vector< vector<score_struct> > matrix = buildScoreMatrix(query->getAligned().length(), refSeqs.size()); //builds and initializes
96 if (m->control_pressed) { return chimera; }
98 fillScoreMatrix(matrix, refSeqs, chimeraPenalty);
100 vector<trace_struct> trace = extractHighestPath(matrix);
102 // cout << "traces\n";
103 // for(int i=0;i<trace.size();i++){
104 // cout << trace[i].col << '\t' << trace[i].oldCol << '\t' << refSeqs[trace[i].row]->getName() << endl;
107 if (trace.size() > 1) { chimera = "yes"; }
108 else { chimera = "no"; }
110 int traceStart = trace[0].col;
111 int traceEnd = trace[trace.size()-1].oldCol;
112 string queryInRange = query->getAligned();
113 queryInRange = queryInRange.substr(traceStart, (traceEnd-traceStart+1));
115 if (m->control_pressed) { return chimera; }
117 //save output results
118 for (int i = 0; i < trace.size(); i++) {
119 int regionStart = trace[i].col;
120 int regionEnd = trace[i].oldCol;
121 int seqIndex = trace[i].row;
125 temp.parent = refSeqs[seqIndex]->getName();
126 temp.parentAligned = db[indexes[seqIndex]]->getAligned();
127 temp.nastRegionStart = spotMap[regionStart];
128 temp.nastRegionEnd = spotMap[regionEnd];
129 temp.regionStart = regionStart;
130 temp.regionEnd = regionEnd;
132 string parentInRange = refSeqs[seqIndex]->getAligned();
133 parentInRange = parentInRange.substr(traceStart, (traceEnd-traceStart+1));
135 temp.queryToParent = computePercentID(queryInRange, parentInRange);
136 temp.divR = (percentIdenticalQueryChimera / temp.queryToParent);
138 string queryInRegion = query->getAligned();
139 queryInRegion = queryInRegion.substr(regionStart, (regionEnd-regionStart+1));
141 string parentInRegion = refSeqs[seqIndex]->getAligned();
142 parentInRegion = parentInRegion.substr(regionStart, (regionEnd-regionStart+1));
144 temp.queryToParentLocal = computePercentID(queryInRegion, parentInRegion);
146 outputResults.push_back(temp);
151 catch(exception& e) {
152 m->errorOut(e, "Maligner", "chimeraMaligner");
156 /***********************************************************************/
157 //removes top matches that do not have minimum coverage with query.
158 vector<Sequence*> Maligner::minCoverageFilter(vector<Sequence*> ref){
160 vector<Sequence*> newRefs;
162 string queryAligned = query->getAligned();
164 for (int i = 0; i < ref.size(); i++) {
166 string refAligned = ref[i]->getAligned();
172 for (int j = 0; j < queryAligned.length(); j++) {
174 if (isalpha(queryAligned[j])) {
177 if (isalpha(refAligned[j])) {
183 int coverage = ((numCovered/(float)numBases)*100);
185 //if coverage above minimum
186 if (coverage > minCoverage) {
187 newRefs.push_back(ref[i]);
195 catch(exception& e) {
196 m->errorOut(e, "Maligner", "minCoverageFilter");
200 /***********************************************************************/
201 // a breakpoint should yield fewer mismatches than this number with respect to the best parent sequence.
202 int Maligner::computeChimeraPenalty() {
205 int numAllowable = ((1.0 - (1.0/minDivR)) * query->getNumBases());
207 // if(numAllowable < 2){ numAllowable = 2; }
209 int penalty = int(numAllowable + 1) * misMatchPenalty;
214 catch(exception& e) {
215 m->errorOut(e, "Maligner", "computeChimeraPenalty");
219 /***********************************************************************/
220 //this is a vertical filter
221 void Maligner::verticalFilter(vector<Sequence*> seqs) {
223 vector<int> gaps; gaps.resize(query->getAligned().length(), 0);
225 string filterString = (string(query->getAligned().length(), '1'));
228 for (int i = 0; i < seqs.size(); i++) {
230 string seqAligned = seqs[i]->getAligned();
232 for (int j = 0; j < seqAligned.length(); j++) {
233 //if this spot is a gap
234 if ((seqAligned[j] == '-') || (seqAligned[j] == '.')) { gaps[j]++; }
238 //zero out spot where all sequences have blanks
239 int numColRemoved = 0;
240 for(int i = 0; i < seqs[0]->getAligned().length(); i++){
241 if(gaps[i] == seqs.size()) { filterString[i] = '0'; numColRemoved++; }
244 map<int, int> newMap;
246 for (int i = 0; i < seqs.size(); i++) {
248 string seqAligned = seqs[i]->getAligned();
249 string newAligned = "";
252 for (int j = 0; j < seqAligned.length(); j++) {
253 //if this spot is not a gap
254 if (filterString[j] == '1') {
255 newAligned += seqAligned[j];
256 newMap[count] = spotMap[j];
261 seqs[i]->setAligned(newAligned);
266 catch(exception& e) {
267 m->errorOut(e, "Maligner", "verticalFilter");
271 //***************************************************************************************************************
272 vector< vector<score_struct> > Maligner::buildScoreMatrix(int cols, int rows) {
275 vector< vector<score_struct> > m(rows);
277 for (int i = 0; i < rows; i++) {
278 for (int j = 0; j < cols; j++) {
280 //initialize each cell
283 temp.score = -9999999;
287 m[i].push_back(temp);
293 catch(exception& e) {
294 m->errorOut(e, "Maligner", "buildScoreMatrix");
299 //***************************************************************************************************************
301 void Maligner::fillScoreMatrix(vector<vector<score_struct> >& ms, vector<Sequence*> seqs, int penalty) {
304 //get matrix dimensions
305 int numCols = query->getAligned().length();
306 int numRows = seqs.size();
308 //initialize first col
309 string queryAligned = query->getAligned();
310 for (int i = 0; i < numRows; i++) {
311 string subjectAligned = seqs[i]->getAligned();
314 if ((!isalpha(queryAligned[0])) && (!isalpha(subjectAligned[0]))) {
316 // ms[i][0].mismatches = 0;
317 }else if (queryAligned[0] == subjectAligned[0]) {
318 ms[i][0].score = matchScore;
319 // ms[i][0].mismatches = 0;
322 // ms[i][0].mismatches = 1;
326 //fill rest of matrix
327 for (int j = 1; j < numCols; j++) { //iterate through matrix columns
329 for (int i = 0; i < numRows; i++) { //iterate through matrix rows
331 string subjectAligned = seqs[i]->getAligned();
333 int matchMisMatchScore = 0;
335 if ((!isalpha(queryAligned[j])) && (!isalpha(subjectAligned[j]))) {
337 }else if ((toupper(queryAligned[j]) == 'N') || (toupper(subjectAligned[j]) == 'N')) {
339 }else if (queryAligned[j] == subjectAligned[j]) {
340 matchMisMatchScore = matchScore;
341 // ms[i][j].mismatches = ms[i][j-1].mismatches;
342 }else if (queryAligned[j] != subjectAligned[j]) {
343 matchMisMatchScore = misMatchPenalty;
344 // ms[i][j].mismatches = ms[i][j-1].mismatches + 1;
347 //compute score based on previous columns scores
348 for (int prevIndex = 0; prevIndex < numRows; prevIndex++) { //iterate through rows
350 int sumScore = matchMisMatchScore + ms[prevIndex][j-1].score;
352 //you are not at yourself
353 if (prevIndex != i) { sumScore += penalty; }
354 if (sumScore < 0) { sumScore = 0; }
356 if (sumScore > ms[i][j].score) {
357 ms[i][j].score = sumScore;
358 ms[i][j].prev = prevIndex;
364 // for(int i=0;i<numRows;i++){
365 // cout << seqs[i]->getName();
366 // for(int j=0;j<numCols;j++){
367 // cout << '\t' << ms[i][j].mismatches;
372 // for(int i=0;i<numRows;i++){
373 // cout << seqs[i]->getName();
374 // for(int j=0;j<numCols;j++){
375 // cout << '\t' << ms[i][j].score;
380 // for(int i=0;i<numRows;i++){
381 // cout << seqs[i]->getName();
382 // for(int j=0;j<numCols;j++){
383 // cout << '\t' << ms[i][j].prev;
390 catch(exception& e) {
391 m->errorOut(e, "Maligner", "fillScoreMatrix");
396 //***************************************************************************************************************
398 vector<trace_struct> Maligner::extractHighestPath(vector<vector<score_struct> > ms) {
402 //get matrix dimensions
403 int numCols = query->getAligned().length();
404 int numRows = ms.size();
407 //find highest score scoring matrix
408 vector<score_struct> highestStruct;
409 int highestScore = 0;
411 for (int i = 0; i < numRows; i++) {
412 for (int j = 0; j < numCols; j++) {
413 if (ms[i][j].score > highestScore) {
414 highestScore = ms[i][j].score;
415 highestStruct.resize(0);
416 highestStruct.push_back(ms[i][j]);
418 else if(ms[i][j].score == highestScore){
419 highestStruct.push_back(ms[i][j]);
424 // cout << highestScore << '\t' << highestStruct.size() << endl;
426 vector<trace_struct> maxTrace;
427 double maxPercentIdenticalQueryAntiChimera = 0;
430 for(int i=0;i<highestStruct.size();i++){
432 vector<score_struct> path;
434 int rowIndex = highestStruct[i].row;
435 int pos = highestStruct[i].col;
436 int score = highestStruct[i].score;
438 while (pos >= 0 && score > 0) {
439 score_struct temp = ms[rowIndex][pos];
442 if (score > 0) { path.push_back(temp); }
444 rowIndex = temp.prev;
448 reverse(path.begin(), path.end());
450 vector<trace_struct> trace = mapTraceRegionsToAlignment(path, refSeqs);
452 // cout << "traces\n";
453 // for(int j=0;j<trace.size();j++){
454 // cout << trace[j].col << '\t' << trace[j].oldCol << '\t' << refSeqs[trace[j].row]->getName() << endl;
457 // Need to do something with this in a bit...
458 // if (trace.size() > 1) { chimera = "yes"; }
459 // else { chimera = "no"; }
461 int traceStart = path[0].col;
462 int traceEnd = path[path.size()-1].col;
463 // cout << "traceStart/End\t" << traceStart << '\t' << traceEnd << endl;
465 string queryInRange = query->getAligned();
466 queryInRange = queryInRange.substr(traceStart, (traceEnd-traceStart+1));
467 // cout << "here" << endl;
468 string chimeraSeq = constructChimericSeq(trace, refSeqs);
469 string antiChimeraSeq = constructAntiChimericSeq(trace, refSeqs);
471 percentIdenticalQueryChimera = computePercentID(queryInRange, chimeraSeq);
472 double percentIdenticalQueryAntiChimera = computePercentID(queryInRange, antiChimeraSeq);
473 // cout << i << '\t' << percentIdenticalQueryChimera << '\t' << percentIdenticalQueryAntiChimera << endl;
475 if(percentIdenticalQueryAntiChimera > maxPercentIdenticalQueryAntiChimera){
476 maxPercentIdenticalQueryAntiChimera = percentIdenticalQueryAntiChimera;
481 // cout << maxPercentIdenticalQueryAntiChimera << '\t' << maxIndex << endl;
485 catch(exception& e) {
486 m->errorOut(e, "Maligner", "extractHighestPath");
491 //***************************************************************************************************************
493 vector<trace_struct> Maligner::mapTraceRegionsToAlignment(vector<score_struct> path, vector<Sequence*> seqs) {
495 vector<trace_struct> trace;
497 int region_index = path[0].row;
498 int region_start = path[0].col;
500 for (int i = 1; i < path.size(); i++) {
502 int next_region_index = path[i].row;
504 if (next_region_index != region_index) {
507 int col_index = path[i].col;
509 temp.col = region_start;
510 temp.oldCol = col_index-1;
511 temp.row = region_index;
513 trace.push_back(temp);
515 region_index = path[i].row;
516 region_start = col_index;
522 temp.col = region_start;
523 temp.oldCol = path[path.size()-1].col;
524 temp.row = region_index;
525 trace.push_back(temp);
528 // cout << trace.size() << endl;
529 // for(int i=0;i<trace.size();i++){
530 // cout << seqs[trace[i].row]->getName() << endl;
537 catch(exception& e) {
538 m->errorOut(e, "Maligner", "mapTraceRegionsToAlignment");
543 //***************************************************************************************************************
545 string Maligner::constructChimericSeq(vector<trace_struct> trace, vector<Sequence*> seqs) {
549 for (int i = 0; i < trace.size(); i++) {
550 // cout << i << '\t' << trace[i].row << '\t' << trace[i].col << '\t' << trace[i].oldCol << endl;
552 string seqAlign = seqs[trace[i].row]->getAligned();
553 seqAlign = seqAlign.substr(trace[i].col, (trace[i].oldCol-trace[i].col+1));
559 catch(exception& e) {
560 m->errorOut(e, "Maligner", "constructChimericSeq");
565 //***************************************************************************************************************
567 string Maligner::constructAntiChimericSeq(vector<trace_struct> trace, vector<Sequence*> seqs) {
569 string antiChimera = "";
571 for (int i = 0; i < trace.size(); i++) {
572 // cout << i << '\t' << (trace.size() - i - 1) << '\t' << trace[i].row << '\t' << trace[i].col << '\t' << trace[i].oldCol << endl;
574 int oppositeIndex = trace.size() - i - 1;
576 string seqAlign = seqs[trace[oppositeIndex].row]->getAligned();
577 seqAlign = seqAlign.substr(trace[i].col, (trace[i].oldCol-trace[i].col+1));
578 antiChimera += seqAlign;
583 catch(exception& e) {
584 m->errorOut(e, "Maligner", "constructChimericSeq");
589 //***************************************************************************************************************
590 float Maligner::computePercentID(string queryAlign, string chimera) {
593 if (queryAlign.length() != chimera.length()) {
594 m->mothurOut("Error, alignment strings are of different lengths: "); m->mothurOutEndLine();
595 m->mothurOut(toString(queryAlign.length())); m->mothurOutEndLine(); m->mothurOutEndLine(); m->mothurOutEndLine(); m->mothurOutEndLine();
596 m->mothurOut(toString(chimera.length())); m->mothurOutEndLine();
602 int numIdentical = 0;
604 for (int i = 0; i < queryAlign.length(); i++) {
605 if ((isalpha(queryAlign[i])) || (isalpha(chimera[i]))) {
607 if (queryAlign[i] == chimera[i]) {
613 if (numBases == 0) { return 0; }
615 float percentIdentical = (numIdentical/(float)numBases) * 100;
617 return percentIdentical;
620 catch(exception& e) {
621 m->errorOut(e, "Maligner", "computePercentID");
625 //***************************************************************************************************************
626 vector<Sequence*> Maligner::getBlastSeqs(Sequence* q, int num) {
629 vector<Sequence*> refResults;
632 string queryUnAligned = q->getUnaligned();
633 string leftQuery = queryUnAligned.substr(0, int(queryUnAligned.length() * 0.33)); //first 1/3 of the sequence
634 string rightQuery = queryUnAligned.substr(int(queryUnAligned.length() * 0.66)); //last 1/3 of the sequence
636 Sequence* queryLeft = new Sequence(q->getName()+"left", leftQuery);
637 Sequence* queryRight = new Sequence(q->getName()+"right", rightQuery);
639 vector<int> tempIndexesRight = databaseLeft->findClosestMegaBlast(queryRight, num+1);
640 vector<int> tempIndexesLeft = databaseLeft->findClosestMegaBlast(queryLeft, num+1);
642 //if ((tempIndexesRight.size() == 0) && (tempIndexesLeft.size() == 0)) { m->mothurOut("megablast returned " + toString(tempIndexesRight.size()) + " results for the right end, and " + toString(tempIndexesLeft.size()) + " for the left end. Needed " + toString(num+1) + ". Unable to process sequence " + q->getName()); m->mothurOutEndLine(); return refResults; }
647 if (tempIndexesRight.size() < tempIndexesLeft.size()) { smaller = tempIndexesRight; larger = tempIndexesLeft; }
648 else { smaller = tempIndexesLeft; larger = tempIndexesRight; }
652 map<int, int>::iterator it;
654 vector<int> mergedResults;
655 for (int i = 0; i < smaller.size(); i++) {
656 //add left if you havent already
657 it = seen.find(smaller[i]);
658 if (it == seen.end()) {
659 mergedResults.push_back(smaller[i]);
660 seen[smaller[i]] = smaller[i];
663 //add right if you havent already
664 it = seen.find(larger[i]);
665 if (it == seen.end()) {
666 mergedResults.push_back(larger[i]);
667 seen[larger[i]] = larger[i];
671 for (int i = smaller.size(); i < larger.size(); i++) {
672 it = seen.find(larger[i]);
673 if (it == seen.end()) {
674 mergedResults.push_back(larger[i]);
675 seen[larger[i]] = larger[i];
679 if (mergedResults.size() < numWanted) { numWanted = mergedResults.size(); }
680 //cout << q->getName() << " merged results size = " << mergedResults.size() << '\t' << "numwanted = " << numWanted << endl;
681 for (int i = 0; i < numWanted; i++) {
682 //cout << db[mergedResults[i]]->getName() << '\t' << mergedResults[i] << endl;
683 if (db[mergedResults[i]]->getName() != q->getName()) {
684 Sequence* temp = new Sequence(db[mergedResults[i]]->getName(), db[mergedResults[i]]->getAligned());
685 refResults.push_back(temp);
686 indexes.push_back(mergedResults[i]);
688 //cout << mergedResults[i] << endl;
690 //cout << "done " << q->getName() << endl;
696 catch(exception& e) {
697 m->errorOut(e, "Maligner", "getBlastSeqs");
701 //***************************************************************************************************************
702 vector<Sequence*> Maligner::getKmerSeqs(Sequence* q, int num) {
707 string queryUnAligned = q->getUnaligned();
708 string leftQuery = queryUnAligned.substr(0, int(queryUnAligned.length() * 0.33)); //first 1/3 of the sequence
709 string rightQuery = queryUnAligned.substr(int(queryUnAligned.length() * 0.66)); //last 1/3 of the sequence
711 Sequence* queryLeft = new Sequence(q->getName(), leftQuery);
712 Sequence* queryRight = new Sequence(q->getName(), rightQuery);
714 vector<int> tempIndexesLeft = databaseLeft->findClosestSequences(queryLeft, numWanted);
715 vector<int> tempIndexesRight = databaseRight->findClosestSequences(queryRight, numWanted);
719 map<int, int>::iterator it;
721 vector<int> mergedResults;
722 for (int i = 0; i < tempIndexesLeft.size(); i++) {
723 //add left if you havent already
724 it = seen.find(tempIndexesLeft[i]);
725 if (it == seen.end()) {
726 mergedResults.push_back(tempIndexesLeft[i]);
727 seen[tempIndexesLeft[i]] = tempIndexesLeft[i];
730 //add right if you havent already
731 it = seen.find(tempIndexesRight[i]);
732 if (it == seen.end()) {
733 mergedResults.push_back(tempIndexesRight[i]);
734 seen[tempIndexesRight[i]] = tempIndexesRight[i];
738 //cout << q->getName() << endl;
739 vector<Sequence*> refResults;
740 for (int i = 0; i < numWanted; i++) {
741 //cout << db[mergedResults[i]]->getName() << endl;
742 Sequence* temp = new Sequence(db[mergedResults[i]]->getName(), db[mergedResults[i]]->getAligned());
743 refResults.push_back(temp);
744 indexes.push_back(mergedResults[i]);
752 catch(exception& e) {
753 m->errorOut(e, "Maligner", "getKmerSeqs");
757 //***************************************************************************************************************