]> git.donarmstrong.com Git - mothur.git/blobdiff - chimeraseqscommand.cpp
added set.dir command and modified commands to redirect input and output, removed...
[mothur.git] / chimeraseqscommand.cpp
index aaed3bab7b56b14460d06de90c9551df70c4351d..63d02f5fd6998e61b65c85012d37d8061f6ff433 100644 (file)
 #include "chimeraseqscommand.h"
 #include "bellerophon.h"
 #include "pintail.h"
+#include "ccode.h"
+#include "chimeracheckrdp.h"
+#include "chimeraslayer.h"
+
 
 //***************************************************************************************************************
 
@@ -22,24 +26,78 @@ ChimeraSeqsCommand::ChimeraSeqsCommand(string option){
                
                else {
                        //valid paramters for this command
-                       string Array[] =  {"fasta", "filter", "correction", "processors", "method", "window", "increment", "template", "conservation", "quantile" };
+                       string Array[] =  {"fasta", "filter", "correction", "processors", "method", "window", "increment", "template", "conservation", "quantile", "mask", "numwanted", "ksize", "svg", "name", "match","mismatch", "divergence", "minsim", "parents", "iters","outputdir","inputdir" };
                        vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
                        
                        OptionParser parser(option);
                        map<string,string> parameters = parser.getParameters();
                        
                        ValidParameters validParameter;
+                       map<string,string>::iterator it;
                        
                        //check to make sure all parameters are valid for command
-                       for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) { 
+                       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("template");
+                               //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["template"] = inputDir + it->second;         }
+                               }
+                               
+                               it = parameters.find("conservation");
+                               //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["conservation"] = inputDir + it->second;             }
+                               }
+                               
+                               it = parameters.find("quantile");
+                               //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["quantile"] = inputDir + it->second;         }
+                               }
+                               
+                               it = parameters.find("name");
+                               //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["name"] = inputDir + it->second;             }
+                               }
+                       }
+
+                       
                        //check for required parameters
                        fastafile = validParameter.validFile(parameters, "fasta", true);
                        if (fastafile == "not open") { abort = true; }
                        else if (fastafile == "not found") { fastafile = ""; mothurOut("fasta is a required parameter for the chimera.seqs command."); mothurOutEndLine(); 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  
+                       }
+
                        templatefile = validParameter.validFile(parameters, "template", true);
                        if (templatefile == "not open") { abort = true; }
                        else if (templatefile == "not found") { templatefile = "";  }   
@@ -50,11 +108,31 @@ ChimeraSeqsCommand::ChimeraSeqsCommand(string option){
                        
                        quanfile = validParameter.validFile(parameters, "quantile", true);
                        if (quanfile == "not open") { abort = true; }
-                       else if (quanfile == "not found") { quanfile = "";  }   
+                       else if (quanfile == "not found") { quanfile = "";  }
                        
+                       namefile = validParameter.validFile(parameters, "name", true);
+                       if (namefile == "not open") { abort = true; }
+                       else if (namefile == "not found") { namefile = "";  }
 
+                       maskfile = validParameter.validFile(parameters, "mask", false);
+                       if (maskfile == "not found") { maskfile = "";  }        
+                       else if (maskfile != "default")  { 
+                               if (inputDir != "") {
+                                       string path = hasPath(maskfile);
+                                       //if the user has not given a path then, add inputdir. else leave path alone.
+                                       if (path == "") {       maskfile = inputDir + maskfile;         }
+                               }
+
+                               ifstream in;
+                               int     ableToOpen = openInputFile(maskfile, in);
+                               if (ableToOpen == 1) { abort = true; }
+                               in.close();
+                       }
+                       
+                       method = validParameter.validFile(parameters, "method", false);                 if (method == "not found") { method = "pintail"; }
+                       
                        string temp;
-                       temp = validParameter.validFile(parameters, "filter", false);                   if (temp == "not found") { temp = "T"; }
+                       temp = validParameter.validFile(parameters, "filter", false);                   if (temp == "not found") { temp = "F"; }
                        filter = isTrue(temp);
                        
                        temp = validParameter.validFile(parameters, "correction", false);               if (temp == "not found") { temp = "T"; }
@@ -63,15 +141,48 @@ ChimeraSeqsCommand::ChimeraSeqsCommand(string option){
                        temp = validParameter.validFile(parameters, "processors", false);               if (temp == "not found") { temp = "1"; }
                        convert(temp, processors);
                        
-                       temp = validParameter.validFile(parameters, "window", false);                   if (temp == "not found") { temp = "0"; }
+                       temp = validParameter.validFile(parameters, "ksize", false);                    if (temp == "not found") { temp = "7"; }
+                       convert(temp, ksize);
+                       
+                       temp = validParameter.validFile(parameters, "svg", false);                              if (temp == "not found") { temp = "F"; }
+                       svg = isTrue(temp);
+                       
+                       temp = validParameter.validFile(parameters, "window", false);   
+                       if ((temp == "not found") && (method == "chimeraslayer")) { temp = "100"; }                     
+                       else if (temp == "not found") { temp = "0"; }
                        convert(temp, window);
-                                       
-                       temp = validParameter.validFile(parameters, "increment", false);                        if (temp == "not found") { temp = "25"; }
+                       
+                       temp = validParameter.validFile(parameters, "match", false);                    if (temp == "not found") { temp = "5"; }
+                       convert(temp, match);
+                       
+                       temp = validParameter.validFile(parameters, "mismatch", false);                 if (temp == "not found") { temp = "-4"; }
+                       convert(temp, mismatch);
+                       
+                       temp = validParameter.validFile(parameters, "divergence", false);               if (temp == "not found") { temp = "1.0"; }
+                       convert(temp, divR);
+                       
+                       temp = validParameter.validFile(parameters, "minsim", false);                   if (temp == "not found") { temp = "90"; }
+                       convert(temp, minSimilarity);
+                       
+                       temp = validParameter.validFile(parameters, "parents", false);                  if (temp == "not found") { temp = "5"; }
+                       convert(temp, parents); 
+                       
+                       temp = validParameter.validFile(parameters, "iters", false);                    if (temp == "not found") { temp = "1000"; }
+                       convert(temp, iters); 
+                        
+                       temp = validParameter.validFile(parameters, "increment", false);                
+                       if ((temp == "not found") && ((method == "chimeracheck") || (method == "chimeraslayer"))) { temp = "10"; }
+                       else if (temp == "not found") { temp = "25"; }
                        convert(temp, increment);
-                               
-                       method = validParameter.validFile(parameters, "method", false);         if (method == "not found") { method = "pintail"; }
                        
-                       if ((method == "pintail") && (templatefile == "")) { mothurOut("You must provide a template file with the pintail method."); mothurOutEndLine(); abort = true;  }
+                       temp = validParameter.validFile(parameters, "numwanted", false);
+                       if ((temp == "not found") && (method == "chimeraslayer")) { temp = "10"; }              
+                       else if (temp == "not found") { temp = "20"; }
+                       convert(temp, numwanted);
+
+                       
+                       
+                       if (((method != "bellerophon")) && (templatefile == "")) { mothurOut("You must provide a template file with the pintail, ccode, chimeraslayer or chimeracheck methods."); mothurOutEndLine(); abort = true;  }
                        
 
                }
@@ -85,15 +196,43 @@ ChimeraSeqsCommand::ChimeraSeqsCommand(string option){
 
 void ChimeraSeqsCommand::help(){
        try {
-               mothurOut("The chimera.seqs command reads a fastafile and creates a sorted priority score list of potentially chimeric sequences (ideally, the sequences should already be aligned).\n");
-               mothurOut("The chimera.seqs command parameters are fasta, filter, correction, processors and method.  fasta is required.\n");
-               mothurOut("The filter parameter allows you to specify if you would like to apply a 50% soft filter.  The default is false. \n");
-               mothurOut("The correction parameter allows you to put more emphasis on the distance between highly similar sequences and less emphasis on the differences between remote homologs.   The default is true. \n");
+       
+               //"fasta", "filter", "correction", "processors", "method", "window", "increment", "template", "conservation", "quantile", "mask", "numwanted", "ksize", "svg", "name"
+               //mothurOut("chimera.seqs ASSUMES that your sequences are ALIGNED and if using a template that the template file sequences are the same length as the fasta file sequences.\n\n");
+               mothurOut("The chimera.seqs command reads a fastafile and creates list of potentially chimeric sequences.\n");
+               mothurOut("The chimera.seqs command parameters are fasta, filter, correction, processors, mask, method, window, increment, template, conservation, quantile, numwanted, ksize, svg, name, iters.\n");
+               mothurOut("The fasta parameter is always required and template is required if using pintail, ccode or chimeracheck.\n");
+               mothurOut("The filter parameter allows you to specify if you would like to apply a vertical and 50% soft filter. \n");
+               mothurOut("The correction parameter allows you to put more emphasis on the distance between highly similar sequences and less emphasis on the differences between remote homologs.\n");
                mothurOut("The processors parameter allows you to specify how many processors you would like to use.  The default is 1. \n");
-               mothurOut("The method parameter allows you to specify the method for finding chimeric sequences.  The default is pintail. \n");
+               mothurOut("The method parameter allows you to specify the method for finding chimeric sequences.  The default is pintail. Options include bellerophon, ccode and chimeracheck \n");
+               mothurOut("The mask parameter allows you to specify a file containing one sequence you wish to use as a mask for the your sequences. \n");
+               mothurOut("The window parameter allows you to specify the window size for searching for chimeras. \n");
+               mothurOut("The increment parameter allows you to specify how far you move each window while finding chimeric sequences.\n");
+               mothurOut("The template parameter allows you to enter a template file containing known non-chimeric sequences. \n");
+               mothurOut("The conservation parameter allows you to enter a frequency file containing the highest bases frequency at each place in the alignment.\n");
+               mothurOut("The quantile parameter allows you to enter a file containing quantiles for a template files sequences.\n");
+               mothurOut("The numwanted parameter allows you to specify how many sequences you would each query sequence compared with.\n");
+               mothurOut("The ksize parameter allows you to input kmersize. \n");
+               mothurOut("The svg parameter allows you to specify whether or not you would like a svg file outputted for each query sequence.\n");
+               mothurOut("The name parameter allows you to enter a file containing names of sequences you would like .svg files for.\n");
+               //mothurOut("The iters parameter allows you to specify the number of bootstrap iters to do with the chimeraslayer method.\n");
+               mothurOut("NOT ALL PARAMETERS ARE USED BY ALL METHODS. Please look below for method specifics.\n\n");
+               mothurOut("Details for each method: \n"); 
+               mothurOut("\tpintail: \n"); 
+               mothurOut("\t\tparameters: fasta=required, template=required, filter=F, mask=no mask, processors=1, window=300, increment=25, conservation=not required, but will improve speed, quantile=not required, but will greatly improve speed. \n"); 
+               mothurOut("\t\tIf you have run chimera.seqs using pintail a .quan and .freq file will be created for your template, if you have not provided them for use in future command executions.\n");
+               mothurOut("\tbellerophon: \n"); 
+               mothurOut("\t\tparameters: fasta=required, filter=F, processors=1, window=1/4 length of seq, increment=25, correction=T. \n"); 
+               mothurOut("\tccode: \n"); 
+               mothurOut("\t\tparameters: fasta=required, template=required, filter=F, mask=no mask, processors=1, window=10% of length, numwanted=20\n"); 
+               mothurOut("\tchimeracheck: \n"); 
+               mothurOut("\t\tparameters: fasta=required, template=required, processors=1, increment=10, ksize=7, svg=F, name=none\n\n"); 
+               //mothurOut("\tchimeraslayer: \n"); 
+               //mothurOut("\t\tparameters: fasta=required, template=required, processors=1, increment=10, mask=no mask, numwanted=10, match=5, mismatch=-4, divergence=1.0, minsim=90, parents=5, iters=1000, window=100. \n\n"); 
                mothurOut("The chimera.seqs command should be in the following format: \n");
                mothurOut("chimera.seqs(fasta=yourFastaFile, filter=yourFilter, correction=yourCorrection, processors=yourProcessors, method=bellerophon) \n");
-               mothurOut("Example: chimera.seqs(fasta=AD.align, filter=True, correction=true, processors=2, method=yourMethod) \n");
+               mothurOut("Example: chimera.seqs(fasta=AD.align, filter=True, correction=true, method=bellerophon, window=200) \n");
                mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFastaFile).\n\n");        
        }
        catch(exception& e) {
@@ -113,28 +252,47 @@ int ChimeraSeqsCommand::execute(){
                
                if (abort == true) { return 0; }
                
-               if (method == "bellerophon")    {               chimera = new Bellerophon(fastafile);                   }
-               else if (method == "pintail")   {               chimera = new Pintail(fastafile, templatefile); 
-                       //saves time to avoid generating it
-                       if (consfile != "")                     {               chimera->setCons(consfile);                                             }
-                       else                                            {               chimera->setCons("");                                                   }
-                       
-                       //saves time to avoid generating it
-                       if (quanfile != "")                     {               chimera->setQuantiles(quanfile);                                }
-                       else                                            {               chimera->setQuantiles("");                                              }
-               }else { mothurOut("Not a valid method."); mothurOutEndLine(); return 0;         }
+               if (method == "bellerophon")                    {               chimera = new Bellerophon(fastafile, outputDir);                        }
+               else if (method == "pintail")                   {               chimera = new Pintail(fastafile, templatefile, outputDir);      }
+               else if (method == "ccode")                             {               chimera = new Ccode(fastafile, templatefile);                           }
+               else if (method == "chimeracheck")              {               chimera = new ChimeraCheckRDP(fastafile, templatefile, outputDir);      }
+               else if (method == "chimeraslayer")             {               chimera = new ChimeraSlayer(fastafile, templatefile);           }
+               else { mothurOut("Not a valid method."); mothurOutEndLine(); return 0;          }
                
                //set user options
+               if (maskfile == "default") { mothurOut("I am using the default 236627 EU009184.1 Shigella dysenteriae str. FBD013."); mothurOutEndLine();  }
+               
+               //saves time to avoid generating it
+               chimera->setCons(consfile);     
+               
+               //saves time to avoid generating it
+               chimera->setQuantiles(quanfile);                                
+               
+               chimera->setMask(maskfile);
                chimera->setFilter(filter);
                chimera->setCorrection(correction);
                chimera->setProcessors(processors);
                chimera->setWindow(window);
                chimera->setIncrement(increment);
+               chimera->setNumWanted(numwanted);
+               chimera->setKmerSize(ksize);
+               chimera->setSVG(svg);
+               chimera->setName(namefile);
+               chimera->setMatch(match);
+               chimera->setMisMatch(mismatch);
+               chimera->setDivR(divR);
+               chimera->setParents(parents);
+               chimera->setMinSim(minSimilarity);
+               chimera->setIters(iters);
+               
                                
                //find chimeras
-               chimera->getChimeras();
+               int error = chimera->getChimeras();
                
-               string outputFileName = getRootName(fastafile) + method + ".chimeras";
+               //there was a problem
+               if (error == 1) {  return 0;  }
+
+               string outputFileName = outputDir + getRootName(getSimpleName(fastafile)) + method + maskfile + ".chimeras";
                ofstream out;
                openOutputFile(outputFileName, out);