X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=trimseqscommand.cpp;h=70b1b4ae8a0c931ff3f84a56d4dd68fa1edd537a;hb=df92022fc75c08b91cefa2c6ca4fd7b23eb480b0;hp=95a85ac23b3a347e25cbc11c03350ef49ae7cb58;hpb=bffbd9ad0d837bc9523d95e7b35c34cfd2631046;p=mothur.git diff --git a/trimseqscommand.cpp b/trimseqscommand.cpp index 95a85ac..70b1b4a 100644 --- a/trimseqscommand.cpp +++ b/trimseqscommand.cpp @@ -11,33 +11,168 @@ //*************************************************************************************************************** -TrimSeqsCommand::TrimSeqsCommand(){ +TrimSeqsCommand::TrimSeqsCommand(string option){ try { - oligos = 0; - totalBarcodeCount = 0; - matchBarcodeCount = 0; + abort = false; - globaldata = GlobalData::getInstance(); - if(globaldata->getFastaFile() == ""){ - cout << "you need to at least enter a fasta file name" << endl; - } + //allow user to run help + if(option == "help") { help(); abort = true; } + + else { + //valid paramters for this command + string AlignArray[] = {"fasta", "flip", "oligos", "maxambig", "maxhomop", "minlength", "maxlength", "qfile", + "qthreshold", "qaverage", "allfiles", "qtrim", "outputdir","inputdir"}; + + vector myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string))); + + OptionParser parser(option); + map parameters = parser.getParameters(); + + ValidParameters validParameter; + map::iterator it; + + //check to make sure all parameters are valid for command + for (it = parameters.begin(); it != parameters.end(); it++) { + if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; } + } + + //if the user changes the input directory command factory will send this info to us in the output parameter + string inputDir = validParameter.validFile(parameters, "inputdir", false); + if (inputDir == "not found"){ inputDir = ""; } + else { + string path; + it = parameters.find("fasta"); + //user has given a template file + if(it != parameters.end()){ + path = hasPath(it->second); + //if the user has not given a path then, add inputdir. else leave path alone. + if (path == "") { parameters["fasta"] = inputDir + it->second; } + } + + it = parameters.find("oligos"); + //user has given a template file + if(it != parameters.end()){ + path = hasPath(it->second); + //if the user has not given a path then, add inputdir. else leave path alone. + if (path == "") { parameters["oligos"] = inputDir + it->second; } + } + + it = parameters.find("qfile"); + //user has given a template file + if(it != parameters.end()){ + path = hasPath(it->second); + //if the user has not given a path then, add inputdir. else leave path alone. + if (path == "") { parameters["qfile"] = inputDir + it->second; } + } + } + + + //check for required parameters + fastaFile = validParameter.validFile(parameters, "fasta", true); + if (fastaFile == "not found") { mothurOut("fasta is a required parameter for the screen.seqs command."); mothurOutEndLine(); abort = true; } + else if (fastaFile == "not open") { abort = true; } + + //if the user changes the output directory command factory will send this info to us in the output parameter + outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){ + outputDir = ""; + outputDir += hasPath(fastaFile); //if user entered a file with a path then preserve it + } - if(isTrue(globaldata->getFlip())) { flip = 1; } - if(globaldata->getOligosFile() != "") { oligos = 1; } - if(!flip && !oligos) { cout << "huh?" << endl; } + //check for optional parameter and set defaults + // ...at some point should added some additional type checking... + string temp; + temp = validParameter.validFile(parameters, "flip", false); + if (temp == "not found"){ flip = 0; } + else if(isTrue(temp)) { flip = 1; } + + temp = validParameter.validFile(parameters, "oligos", true); + if (temp == "not found"){ oligoFile = ""; } + else if(temp == "not open"){ abort = true; } + else { oligoFile = temp; } + + temp = validParameter.validFile(parameters, "maxambig", false); if (temp == "not found") { temp = "-1"; } + convert(temp, maxAmbig); + + temp = validParameter.validFile(parameters, "maxhomop", false); if (temp == "not found") { temp = "0"; } + convert(temp, maxHomoP); + + temp = validParameter.validFile(parameters, "minlength", false); if (temp == "not found") { temp = "0"; } + convert(temp, minLength); + + temp = validParameter.validFile(parameters, "maxlength", false); if (temp == "not found") { temp = "0"; } + convert(temp, maxLength); + + temp = validParameter.validFile(parameters, "qfile", true); + if (temp == "not found") { qFileName = ""; } + else if(temp == "not open") { abort = true; } + else { qFileName = temp; } + + temp = validParameter.validFile(parameters, "qthreshold", false); if (temp == "not found") { temp = "0"; } + convert(temp, qThreshold); + + temp = validParameter.validFile(parameters, "qtrim", false); if (temp == "not found") { temp = "F"; } + qtrim = isTrue(temp); + + temp = validParameter.validFile(parameters, "qaverage", false); if (temp == "not found") { temp = "0"; } + convert(temp, qAverage); + + temp = validParameter.validFile(parameters, "allfiles", false); if (temp == "not found") { temp = "F"; } + allFiles = isTrue(temp); + + if(allFiles && oligoFile == ""){ + mothurOut("You selected allfiles, but didn't enter an oligos file. Ignoring the allfiles request."); mothurOutEndLine(); + } + if((qAverage != 0 && qThreshold != 0) && qFileName == ""){ + mothurOut("You didn't provide a quality file name, quality criteria will be ignored."); mothurOutEndLine(); + qAverage=0; + qThreshold=0; + } + if(!flip && oligoFile=="" && !maxLength && !minLength && (maxAmbig==-1) && !maxHomoP && qFileName == ""){ + mothurOut("You didn't set any options... quiting command."); mothurOutEndLine(); + abort = true; + } + } } catch(exception& e) { - cout << "Standard Error: " << e.what() << " has occurred in the TrimSeqsCommand class Function TrimSeqsCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n"; + errorOut(e, "TrimSeqsCommand", "TrimSeqsCommand"); exit(1); } - catch(...) { - cout << "An unknown error has occurred in the TrimSeqsCommand class function TrimSeqsCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n"; +} +//********************************************************************************************************************** + +void TrimSeqsCommand::help(){ + try { + mothurOut("The trim.seqs command reads a fastaFile and creates .....\n"); + mothurOut("The trim.seqs command parameters are fasta, flip, oligos, maxambig, maxhomop, minlength, maxlength, qfile, qthreshold, qaverage, qtrim and allfiles.\n"); + mothurOut("The fasta parameter is required.\n"); + mothurOut("The flip parameter .... The default is 0.\n"); + mothurOut("The oligos parameter .... The default is "".\n"); + mothurOut("The maxambig parameter .... The default is -1.\n"); + mothurOut("The maxhomop parameter .... The default is 0.\n"); + mothurOut("The minlength parameter .... The default is 0.\n"); + mothurOut("The maxlength parameter .... The default is 0.\n"); + mothurOut("The qfile parameter .....\n"); + mothurOut("The qthreshold parameter .... The default is 0.\n"); + mothurOut("The qaverage parameter .... The default is 0.\n"); + mothurOut("The allfiles parameter .... The default is F.\n"); + mothurOut("The qtrim parameter .... The default is F.\n"); + mothurOut("The trim.seqs command should be in the following format: \n"); + mothurOut("trim.seqs(fasta=yourFastaFile, flip=yourFlip, oligos=yourOligos, maxambig=yourMaxambig, \n"); + mothurOut("maxhomop=yourMaxhomop, minlength=youMinlength, maxlength=yourMaxlength) \n"); + mothurOut("Example trim.seqs(fasta=abrecovery.fasta, flip=..., oligos=..., maxambig=..., maxhomop=..., minlength=..., maxlength=...).\n"); + mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n"); + mothurOut("For more details please check out the wiki http://www.mothur.org/wiki/Trim.seqs .\n\n"); + + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "help"); exit(1); - } + } } + //*************************************************************************************************************** TrimSeqsCommand::~TrimSeqsCommand(){ /* do nothing */ } @@ -46,192 +181,457 @@ TrimSeqsCommand::~TrimSeqsCommand(){ /* do nothing */ } int TrimSeqsCommand::execute(){ try{ - getOligos(); + + if (abort == true) { return 0; } + + numFPrimers = 0; //this needs to be initialized + numRPrimers = 0; ifstream inFASTA; - openInputFile(globaldata->getFastaFile(), inFASTA); - + openInputFile(fastaFile, inFASTA); + ofstream outFASTA; - string trimSeqFile = getRootName(globaldata->getFastaFile()) + "trim.fasta"; + string trimSeqFile = outputDir + getRootName(getSimpleName(fastaFile)) + "trim.fasta"; openOutputFile(trimSeqFile, outFASTA); ofstream outGroups; - string groupFile = getRootName(globaldata->getFastaFile()) + "groups"; - openOutputFile(groupFile, outGroups); - + vector fastaFileNames; + if(oligoFile != ""){ + string groupFile = outputDir + getRootName(getSimpleName(fastaFile)) + "groups"; + openOutputFile(groupFile, outGroups); + getOligos(fastaFileNames); + } + ofstream scrapFASTA; - string scrapSeqFile = getRootName(globaldata->getFastaFile()) + "scrap.fasta"; + string scrapSeqFile = outputDir + getRootName(getSimpleName(fastaFile)) + "scrap.fasta"; openOutputFile(scrapSeqFile, scrapFASTA); - - bool success; + ifstream qFile; + if(qFileName != "") { openInputFile(qFileName, qFile); } + + bool success; + while(!inFASTA.eof()){ Sequence currSeq(inFASTA); - string origSeq = currSeq.getUnaligned(); - string group; - string trashCode = ""; - if(barcodes.size() != 0){ - success = stripBarcode(currSeq, group); - if(!success){ trashCode += 'b'; } - } - if(numFPrimers != 0){ - success = stripForward(currSeq); - if(!success){ trashCode += 'f'; } - } - if(numRPrimers != 0){ - success = stripReverse(currSeq); - if(!success){ trashCode += 'r'; } - } - if(flip){ currSeq.reverseComplement(); } // should go last - - if(trashCode.length() == 0){ - currSeq.printSequence(outFASTA); - outGroups << currSeq.getName() << '\t' << group << endl; - } - else{ - currSeq.setName(currSeq.getName() + '|' + trashCode); - currSeq.setUnaligned(origSeq); - currSeq.printSequence(scrapFASTA); - } + string origSeq = currSeq.getUnaligned(); + if (origSeq != "") { + int group; + string trashCode = ""; + + if(qFileName != ""){ + if(qThreshold != 0) { success = stripQualThreshold(currSeq, qFile); } + else if(qAverage != 0) { success = cullQualAverage(currSeq, qFile); } + if ((!qtrim) && (origSeq.length() != currSeq.getUnaligned().length())) { + success = 0; //if you don't want to trim and the sequence does not meet quality requirements, move to scrap + } + if(!success) { trashCode += 'q'; } + } + + if(barcodes.size() != 0){ + success = stripBarcode(currSeq, group); + if(!success){ trashCode += 'b'; } + } + if(numFPrimers != 0){ + success = stripForward(currSeq); + if(!success){ trashCode += 'f'; } + } + + if(numRPrimers != 0){ + success = stripReverse(currSeq); + if(!success){ trashCode += 'r'; } + } + + if(minLength > 0 || maxLength > 0){ + success = cullLength(currSeq); + if(!success){ trashCode += 'l'; } + } + if(maxHomoP > 0){ + success = cullHomoP(currSeq); + if(!success){ trashCode += 'h'; } + } + if(maxAmbig != -1){ + success = cullAmbigs(currSeq); + if(!success){ trashCode += 'n'; } + } + + if(flip){ currSeq.reverseComplement(); } // should go last + + if(trashCode.length() == 0){ + currSeq.setAligned(currSeq.getUnaligned()); //this is because of a modification we made to the sequence class to fix a bug. all seqs have an aligned version, which is the version that gets printed. + currSeq.printSequence(outFASTA); + if(barcodes.size() != 0){ + outGroups << currSeq.getName() << '\t' << groupVector[group] << endl; + + if(allFiles){ + currSeq.printSequence(*fastaFileNames[group]); + } + } + } + else{ + currSeq.setName(currSeq.getName() + '|' + trashCode); + currSeq.setUnaligned(origSeq); + currSeq.printSequence(scrapFASTA); + } + } gobble(inFASTA); } inFASTA.close(); outFASTA.close(); scrapFASTA.close(); outGroups.close(); + if(qFileName != "") { qFile.close(); } + + for(int i=0;iclose(); + delete fastaFileNames[i]; + } + for(int i=0;i'){ + inFASTA >> seqName; + outGroups << seqName << '\t' << groupVector[i] << endl; + } + while (!inFASTA.eof()) { char c = inFASTA.get(); if (c == 10 || c == 13){ break; } } + } + outGroups.close(); + inFASTA.close(); + } + return 0; } catch(exception& e) { - cout << "Standard Error: " << e.what() << " has occurred in the TrimSeqsCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n"; + errorOut(e, "TrimSeqsCommand", "execute"); exit(1); } - catch(...) { - cout << "An unknown error has occurred in the TrimSeqsCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n"; +} + +//*************************************************************************************************************** + +void TrimSeqsCommand::getOligos(vector& outFASTAVec){ + try { + ifstream inOligos; + openInputFile(oligoFile, inOligos); + + ofstream test; + + string type, oligo, group; + int index=0; + + while(!inOligos.eof()){ + inOligos >> type; + + if(type[0] == '#'){ + while (!inOligos.eof()) { char c = inOligos.get(); if (c == 10 || c == 13){ break; } } // get rest of line if there's any crap there + } + else{ + inOligos >> oligo; + + for(int i=0;i> group; + barcodes[oligo]=index++; + groupVector.push_back(group); + + if(allFiles){ + outFASTAVec.push_back(new ofstream((outputDir + getRootName(getSimpleName(fastaFile)) + group + ".fasta").c_str(), ios::ate)); + } + } + } + } + + inOligos.close(); + + numFPrimers = forPrimer.size(); + numRPrimers = revPrimer.size(); + + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "getOligos"); exit(1); } + } //*************************************************************************************************************** -void TrimSeqsCommand::getOligos(){ +bool TrimSeqsCommand::stripBarcode(Sequence& seq, int& group){ + try { + string rawSequence = seq.getUnaligned(); + bool success = 0; //guilty until proven innocent + + for(map::iterator it=barcodes.begin();it!=barcodes.end();it++){ + string oligo = it->first; + if(rawSequence.length() < oligo.length()){ //let's just assume that the barcodes are the same length + success = 0; + break; + } + + if(compareDNASeq(oligo, rawSequence.substr(0,oligo.length()))){ + group = it->second; + seq.setUnaligned(rawSequence.substr(oligo.length())); + success = 1; + break; + } + } + return success; + + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "stripBarcode"); + exit(1); + } - ifstream inOligos; - openInputFile(globaldata->getOligosFile(), inOligos); +} - string type, oligo, group; - - while(!inOligos.eof()){ - inOligos >> type; +//*************************************************************************************************************** + +bool TrimSeqsCommand::stripForward(Sequence& seq){ + try { + string rawSequence = seq.getUnaligned(); + bool success = 0; //guilty until proven innocent - if(type == "forward"){ - inOligos >> oligo; - forPrimer.push_back(oligo); - } - else if(type == "reverse"){ - inOligos >> oligo; - revPrimer.push_back(oligo); - } - else if(type == "barcode"){ - inOligos >> oligo >> group; - barcodes[oligo]=group; - } - else if(type[0] == '#'){ - char c; - while ((c = inOligos.get()) != EOF) { if (c == 10){ break; } } // get rest of line + for(int i=0;i::iterator it=barcodes.begin();it!=barcodes.end();it++){ - string oligo = it->first; + int length = seq.getNumBases(); + bool success = 0; //guilty until proven innocent - if(rawSequence.length() < oligo.length()){ //let's just assume that the barcodes are the same length - success = 0; - break; - } + if(length >= minLength && maxLength == 0) { success = 1; } + else if(length >= minLength && length <= maxLength) { success = 1; } + else { success = 0; } - if (rawSequence.compare(0,oligo.length(),oligo) == 0){ - group = it->second; - seq.setUnaligned(rawSequence.substr(oligo.length())); - matchBarcodeCount++; - success = 1; - break; - } + return success; + + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "cullLength"); + exit(1); } - totalBarcodeCount++; - return success; } //*************************************************************************************************************** -bool TrimSeqsCommand::stripForward(Sequence& seq){ +bool TrimSeqsCommand::cullHomoP(Sequence& seq){ + try { + int longHomoP = seq.getLongHomoPolymer(); + bool success = 0; //guilty until proven innocent + + if(longHomoP <= maxHomoP){ success = 1; } + else { success = 0; } + + return success; + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "cullHomoP"); + exit(1); + } - string rawSequence = seq.getUnaligned(); - bool success = 0; //guilty until proven innocent +} + +//*************************************************************************************************************** + +bool TrimSeqsCommand::cullAmbigs(Sequence& seq){ + try { + int numNs = seq.getAmbigBases(); + bool success = 0; //guilty until proven innocent + + if(numNs <= maxAmbig) { success = 1; } + else { success = 0; } + + return success; + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "cullAmbigs"); + exit(1); + } - for(int i=0;i> name; + if (name.length() != 0) { if(name.substr(1) != seq.getName()) { mothurOut("sequence name mismatch btwn fasta and qual file"); mothurOutEndLine(); } } + while (!qFile.eof()) { char c = qFile.get(); if (c == 10 || c == 13){ break; } } + + int score; + int end = seqLength; - if(rawSequence.length() < oligo.length()){ - success = 0; - break; + for(int i=0;i> score; + + if(score <= qThreshold){ + end = i; + break; + } } + for(int i=end+1;i> score; + } + + seq.setUnaligned(rawSequence.substr(0,end)); - if(rawSequence.compare(rawSequence.length()-oligo.length(),oligo.length(),oligo) == 0){ - seq.setUnaligned(rawSequence.substr(rawSequence.length()-oligo.length())); - matchRPrimerCount++; - success = 1; - break; + return 1; + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "stripQualThreshold"); + exit(1); + } +} + +//*************************************************************************************************************** + +bool TrimSeqsCommand::cullQualAverage(Sequence& seq, ifstream& qFile){ + try { + string rawSequence = seq.getUnaligned(); + int seqLength = seq.getNumBases(); + bool success = 0; //guilty until proven innocent + string name; + + qFile >> name; + if (name[0] == '>') { if(name.substr(1) != seq.getName()) { mothurOut("sequence name mismatch btwn fasta: " + seq.getName() + " and qual file: " + name); mothurOutEndLine(); } } + + while (!qFile.eof()) { char c = qFile.get(); if (c == 10 || c == 13){ break; } } + + float score; + float average = 0; + + for(int i=0;i> score; + average += score; } - } - - totalRPrimerCount++; - return success; - + average /= seqLength; + + if(average >= qAverage) { success = 1; } + else { success = 0; } + + return success; + } + catch(exception& e) { + errorOut(e, "TrimSeqsCommand", "cullQualAverage"); + exit(1); + } } //***************************************************************************************************************