]> git.donarmstrong.com Git - mothur.git/blobdiff - getlineagecommand.cpp
working on current change
[mothur.git] / getlineagecommand.cpp
index 4948a1a095343748dde3f467ff59c9ce5e050702..0d836130d31124298a13c3a388267144cf5538ff 100644 (file)
 #include "sequence.hpp"
 #include "listvector.hpp"
 
-
 //**********************************************************************************************************************
-vector<string> GetLineageCommand::getValidParameters(){        
+vector<string> GetLineageCommand::setParameters(){     
        try {
-               string Array[] =  {"fasta","name", "group", "alignreport", "taxon", "dups", "list","taxonomy","outputdir","inputdir"};
-               vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+               CommandParameter pfasta("fasta", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(pfasta);
+               CommandParameter pname("name", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(pname);
+               CommandParameter pgroup("group", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(pgroup);
+               CommandParameter plist("list", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(plist);
+               CommandParameter ptaxonomy("taxonomy", "InputTypes", "", "", "none", "FNGLT", "none",false,true); parameters.push_back(ptaxonomy);
+               CommandParameter palignreport("alignreport", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(palignreport);
+               CommandParameter ptaxon("taxon", "String", "", "", "", "", "",false,true); parameters.push_back(ptaxon);
+               CommandParameter pdups("dups", "Boolean", "", "T", "", "", "",false,false); parameters.push_back(pdups);
+               CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir);
+               CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir);
+               
+               vector<string> myArray;
+               for (int i = 0; i < parameters.size(); i++) {   myArray.push_back(parameters[i].name);          }
                return myArray;
        }
        catch(exception& e) {
-               m->errorOut(e, "GetLineageCommand", "getValidParameters");
+               m->errorOut(e, "GetLineageCommand", "setParameters");
+               exit(1);
+       }
+}
+//**********************************************************************************************************************
+string GetLineageCommand::getHelpString(){     
+       try {
+               string helpString = "";
+               helpString += "The get.lineage command reads a taxonomy file and any of the following file types: fasta, name, group, list or alignreport file.\n";
+               helpString += "It outputs a file containing only the sequences from the taxonomy file that are from the taxon requested.\n";
+               helpString += "The get.lineage command parameters are taxon, fasta, name, group, list, taxonomy, alignreport and dups.  You must provide taxonomy unless you have a valid current taxonomy file.\n";
+               helpString += "The dups parameter allows you to add the entire line from a name file if you add any name from the line. default=false. \n";
+               helpString += "The taxon parameter allows you to select the taxons you would like to get and is required.\n";
+               helpString += "You may enter your taxons with confidence scores, doing so will get only those sequences that belong to the taxonomy and whose cofidence scores is above the scores you give.\n";
+               helpString += "If they belong to the taxonomy and have confidences below those you provide the sequence will not be selected.\n";
+               helpString += "The get.lineage command should be in the following format: get.lineage(taxonomy=yourTaxonomyFile, taxon=yourTaxons).\n";
+               helpString += "Example get.lineage(taxonomy=amazon.silva.taxonomy, taxon=Bacteria;Firmicutes;Bacilli;Lactobacillales;).\n";
+               helpString += "Note: If you are running mothur in script mode you must wrap the taxon in ' characters so mothur will ignore the ; in the taxon.\n";
+               helpString += "Example get.lineage(taxonomy=amazon.silva.taxonomy, taxon='Bacteria;Firmicutes;Bacilli;Lactobacillales;').\n";
+               helpString += "Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n";
+               return helpString;
+       }
+       catch(exception& e) {
+               m->errorOut(e, "GetLineageCommand", "getHelpString");
                exit(1);
        }
 }
+
 //**********************************************************************************************************************
 GetLineageCommand::GetLineageCommand(){        
        try {
-               abort = true;
-               //initialize outputTypes
+               abort = true; calledHelp = true; 
+               setParameters();
                vector<string> tempOutNames;
                outputTypes["fasta"] = tempOutNames;
                outputTypes["taxonomy"] = tempOutNames;
@@ -43,40 +77,16 @@ GetLineageCommand::GetLineageCommand(){
        }
 }
 //**********************************************************************************************************************
-vector<string> GetLineageCommand::getRequiredParameters(){     
-       try {
-               string Array[] =  {"taxonomy","taxon"};
-               vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
-               return myArray;
-       }
-       catch(exception& e) {
-               m->errorOut(e, "GetLineageCommand", "getRequiredParameters");
-               exit(1);
-       }
-}
-//**********************************************************************************************************************
-vector<string> GetLineageCommand::getRequiredFiles(){  
-       try {
-               vector<string> myArray;
-               return myArray;
-       }
-       catch(exception& e) {
-               m->errorOut(e, "GetLineageCommand", "getRequiredFiles");
-               exit(1);
-       }
-}
-//**********************************************************************************************************************
 GetLineageCommand::GetLineageCommand(string option)  {
        try {
-               abort = false;
+               abort = false; calledHelp = false;   
                                
                //allow user to run help
-               if(option == "help") { help(); abort = true; }
+               if(option == "help") { help(); abort = true; calledHelp = true; }
+               else if(option == "citation") { citation(); abort = true; calledHelp = true;}
                
                else {
-                       //valid paramters for this command
-                       string Array[] =  {"fasta","name", "group", "alignreport", "taxon", "dups", "list","taxonomy","outputdir","inputdir"};
-                       vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+                       vector<string> myArray = setParameters();
                        
                        OptionParser parser(option);
                        map<string,string> parameters = parser.getParameters();
@@ -159,15 +169,18 @@ GetLineageCommand::GetLineageCommand(string option)  {
                        //check for required parameters                 
                        fastafile = validParameter.validFile(parameters, "fasta", true);
                        if (fastafile == "not open") { abort = true; }
-                       else if (fastafile == "not found") {  fastafile = "";  }        
+                       else if (fastafile == "not found") {  fastafile = "";  }
+                       else { m->setFastaFile(fastafile); }
                        
                        namefile = validParameter.validFile(parameters, "name", true);
                        if (namefile == "not open") { abort = true; }
                        else if (namefile == "not found") {  namefile = "";  }  
+                       else { m->setNameFile(namefile); }
                        
                        groupfile = validParameter.validFile(parameters, "group", true);
                        if (groupfile == "not open") { abort = true; }
                        else if (groupfile == "not found") {  groupfile = "";  }        
+                       else { m->setGroupFile(groupfile); }
                        
                        alignfile = validParameter.validFile(parameters, "alignreport", true);
                        if (alignfile == "not open") { abort = true; }
@@ -176,10 +189,15 @@ GetLineageCommand::GetLineageCommand(string option)  {
                        listfile = validParameter.validFile(parameters, "list", true);
                        if (listfile == "not open") { abort = true; }
                        else if (listfile == "not found") {  listfile = "";  }
+                       else { m->setListFile(listfile); }
                        
                        taxfile = validParameter.validFile(parameters, "taxonomy", true);
                        if (taxfile == "not open") { abort = true; }
-                       else if (taxfile == "not found") {  taxfile = ""; m->mothurOut("The taxonomy parameter is required for the get.lineage command."); m->mothurOutEndLine();  abort = true; }
+                       else if (taxfile == "not found") {                              
+                               taxfile = m->getTaxonomyFile(); 
+                               if (taxfile != "") { m->mothurOut("Using " + taxfile + " as input file for the taxonomy parameter."); m->mothurOutEndLine(); }
+                               else {  m->mothurOut("You have no current taxonomy file and the taxonomy parameter is required."); m->mothurOutEndLine(); abort = true; }
+                       }else { m->setTaxonomyFile(taxfile); }
                        
                        string usedDups = "true";
                        string temp = validParameter.validFile(parameters, "dups", false);      
@@ -196,12 +214,9 @@ GetLineageCommand::GetLineageCommand(string option)  {
                                if (taxons[0] == '\'') {  taxons = taxons.substr(1); }
                                if (taxons[(taxons.length()-1)] == '\'') {  taxons = taxons.substr(0, (taxons.length()-1)); }
                        }
-                       
+                       m->splitAtChar(taxons, listOfTaxons, '-');
                        
                        if ((fastafile == "") && (namefile == "") && (groupfile == "") && (alignfile == "") && (listfile == "") && (taxfile == ""))  { m->mothurOut("You must provide one of the following: fasta, name, group, alignreport, taxonomy or listfile."); m->mothurOutEndLine(); abort = true; }
-               
-                       if ((usedDups != "") && (namefile == "")) {  m->mothurOut("You may only use dups with the name option."); m->mothurOutEndLine();  abort = true; }                       
-
                }
 
        }
@@ -212,31 +227,10 @@ GetLineageCommand::GetLineageCommand(string option)  {
 }
 //**********************************************************************************************************************
 
-void GetLineageCommand::help(){
-       try {
-               m->mothurOut("The get.lineage command reads a taxonomy file and any of the following file types: fasta, name, group, list or alignreport file.\n");
-               m->mothurOut("It outputs a file containing only the sequences from the taxonomy file that are from the taxon requested.\n");
-               m->mothurOut("The get.lineage command parameters are taxon, fasta, name, group, list, taxonomy, alignreport and dups.  You must provide taxonomy and taxon.\n");
-               m->mothurOut("The dups parameter allows you to add the entire line from a name file if you add any name from the line. default=false. \n");
-               m->mothurOut("The taxon parameter allows you to select the taxons you would like to get.\n");
-               m->mothurOut("The get.lineage command should be in the following format: get.lineage(taxonomy=yourTaxonomyFile, taxon=yourTaxons).\n");
-               m->mothurOut("Example get.lineage(taxonomy=amazon.silva.taxonomy, taxon=Bacteria;Firmicutes;Bacilli;Lactobacillales;).\n");
-               m->mothurOut("Note: If you are running mothur in script mode you must wrap the taxon in ' characters so mothur will ignore the ; in the taxon.\n");
-               m->mothurOut("Example get.lineage(taxonomy=amazon.silva.taxonomy, taxon='Bacteria;Firmicutes;Bacilli;Lactobacillales;').\n");
-               m->mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n\n");
-       }
-       catch(exception& e) {
-               m->errorOut(e, "GetLineageCommand", "help");
-               exit(1);
-       }
-}
-
-//**********************************************************************************************************************
-
 int GetLineageCommand::execute(){
        try {
                
-               if (abort == true) { return 0; }
+               if (abort == true) { if (calledHelp) { return 0; }  return 2;   }
                
                if (m->control_pressed) { return 0; }
                
@@ -256,6 +250,33 @@ int GetLineageCommand::execute(){
                        m->mothurOut("Output File Names: "); m->mothurOutEndLine();
                        for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
                        m->mothurOutEndLine();
+                       
+                       //set fasta file as new current fastafile
+                       string current = "";
+                       itTypes = outputTypes.find("fasta");
+                       if (itTypes != outputTypes.end()) {
+                               if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setFastaFile(current); }
+                       }
+                       
+                       itTypes = outputTypes.find("name");
+                       if (itTypes != outputTypes.end()) {
+                               if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setNameFile(current); }
+                       }
+                       
+                       itTypes = outputTypes.find("group");
+                       if (itTypes != outputTypes.end()) {
+                               if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setGroupFile(current); }
+                       }
+                       
+                       itTypes = outputTypes.find("list");
+                       if (itTypes != outputTypes.end()) {
+                               if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setListFile(current); }
+                       }
+                       
+                       itTypes = outputTypes.find("taxonomy");
+                       if (itTypes != outputTypes.end()) {
+                               if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setTaxonomyFile(current); }
+                       }                       
                }
                
                return 0;               
@@ -414,15 +435,7 @@ int GetLineageCommand::readName(){
                        if (dups) { hold = secondCol; }
                        
                        vector<string> parsedNames;
-                       //parse second column saving each name
-                       while (secondCol.find_first_of(',') != -1) { 
-                               name = secondCol.substr(0,secondCol.find_first_of(','));
-                               secondCol = secondCol.substr(secondCol.find_first_of(',')+1, secondCol.length());
-                               parsedNames.push_back(name);
-                       }
-                       
-                       //get name after last ,
-                       parsedNames.push_back(secondCol);
+                       m->splitAtComma(secondCol, parsedNames);
                        
                        vector<string> validSecond;
                        for (int i = 0; i < parsedNames.size(); i++) {
@@ -540,7 +553,21 @@ int GetLineageCommand::readTax(){
                m->openInputFile(taxfile, in);
                string name, tax;
                
-               bool wroteSomething = false;
+               //bool wroteSomething = false;
+               vector<bool> taxonsHasConfidence; taxonsHasConfidence.resize(listOfTaxons.size(), false);
+               vector< vector< map<string, float> > > searchTaxons; searchTaxons.resize(listOfTaxons.size());
+               vector<string> noConfidenceTaxons; noConfidenceTaxons.resize(listOfTaxons.size(), "");
+               
+               for (int i = 0; i < listOfTaxons.size(); i++) {
+                       noConfidenceTaxons[i] = listOfTaxons[i];
+                       int hasConPos = listOfTaxons[i].find_first_of('(');
+                       if (hasConPos != string::npos) {  
+                               taxonsHasConfidence[i] = true; 
+                               searchTaxons[i] = getTaxons(listOfTaxons[i]); 
+                               noConfidenceTaxons[i] = removeConfidences(listOfTaxons[i]);
+                       }
+               }
+               
                
                while(!in.eof()){
 
@@ -549,19 +576,95 @@ int GetLineageCommand::readTax(){
                        in >> name;                             //read from first column
                        in >> tax;                      //read from second column
                        
-                       string newtax = tax;
-                       
-                       //if the users file contains confidence scores we want to ignore them when searching for the taxons
-                       int hasConfidences = tax.find_first_of('(');
-                       if (hasConfidences != string::npos) { 
-                               newtax = removeConfidences(tax);
-                       }
+                       for (int j = 0; j < listOfTaxons.size(); j++) {
+                                                       
+                               string newtax = tax;
                        
-                       int pos = newtax.find(taxons);
+                               //if the users file contains confidence scores we want to ignore them when searching for the taxons, unless the taxon has them
+                               if (!taxonsHasConfidence[j]) {
+                                       int hasConfidences = tax.find_first_of('(');
+                                       if (hasConfidences != string::npos) { 
+                                               newtax = removeConfidences(tax);
+                                       }
+                               
+                                       int pos = newtax.find(noConfidenceTaxons[j]);
+                               
+                                       if (pos != string::npos) { //this sequence contains the taxon the user wants
+                                               names.insert(name); 
+                                               out << name << '\t' << tax << endl;
+                                               //since you belong to at least one of the taxons we want you are included so no need to search for other
+                                               break;
+                                       }
+                               }else{//if listOfTaxons[i] has them and you don't them remove taxons
+                                       int hasConfidences = tax.find_first_of('(');
+                                       if (hasConfidences == string::npos) { 
+                                       
+                                               int pos = newtax.find(noConfidenceTaxons[j]);
+                                       
+                                               if (pos != string::npos) { //this sequence contains the taxon the user wants
+                                                       names.insert(name);
+                                                       out << name << '\t' << tax << endl;
+                                                       //since you belong to at least one of the taxons we want you are included so no need to search for other
+                                                       break;
+                                               }
+                                       }else { //both have confidences so we want to make sure the users confidences are greater then or equal to the taxons
+                                               //first remove confidences from both and see if the taxonomy exists
+                                       
+                                               string noNewTax = tax;
+                                               int hasConfidences = tax.find_first_of('(');
+                                               if (hasConfidences != string::npos) { 
+                                                       noNewTax = removeConfidences(tax);
+                                               }
+                                       
+                                               int pos = noNewTax.find(noConfidenceTaxons[j]);
+                                       
+                                               if (pos != string::npos) { //if yes, then are the confidences okay
+                                               
+                                                       bool good = true;
+                                                       vector< map<string, float> > usersTaxon = getTaxons(newtax);
+                                               
+                                                       //the usersTaxon is most likely longer than the searchTaxons, and searchTaxon[0] may relate to userTaxon[4]
+                                                       //we want to "line them up", so we will find the the index where the searchstring starts
+                                                       int index = 0;
+                                                       for (int i = 0; i < usersTaxon.size(); i++) {
+                                                       
+                                                               if (usersTaxon[i].begin()->first == searchTaxons[j][0].begin()->first) { 
+                                                                       index = i;  
+                                                                       int spot = 0;
+                                                                       bool goodspot = true;
+                                                                       //is this really the start, or are we dealing with a taxon of the same name?
+                                                                       while ((spot < searchTaxons[j].size()) && ((i+spot) < usersTaxon.size())) {
+                                                                               if (usersTaxon[i+spot].begin()->first != searchTaxons[j][spot].begin()->first) { goodspot = false; break; }
+                                                                               else { spot++; }
+                                                                       }
+                                                               
+                                                                       if (goodspot) { break; }
+                                                               }
+                                                       }
+                                               
+                                                       for (int i = 0; i < searchTaxons[j].size(); i++) {
+                                                       
+                                                               if ((i+index) < usersTaxon.size()) { //just in case, should never be false
+                                                                       if (usersTaxon[i+index].begin()->second < searchTaxons[j][i].begin()->second) { //is the users cutoff less than the search taxons
+                                                                               good = false;
+                                                                               break;
+                                                                       }
+                                                               }else {
+                                                                       good = false;
+                                                                       break;
+                                                               }
+                                                       }
+                                               
+                                                       //passed the test so add you
+                                                       if (good) {
+                                                               names.insert(name);
+                                                               out << name << '\t' << tax << endl;
+                                                               break;
+                                                       }
+                                               }
+                                       }
+                               }
                        
-                       if (pos != string::npos) { //this sequence contains the taxon the user wants
-                               names.insert(name);
-                               out << name << '\t' << tax << endl;
                        }
                        
                        m->gobble(in);
@@ -581,6 +684,48 @@ int GetLineageCommand::readTax(){
        }
 }
 /**************************************************************************************************/
+vector< map<string, float> > GetLineageCommand::getTaxons(string tax) {
+       try {
+               
+               vector< map<string, float> > t;
+               string taxon = "";
+               int taxLength = tax.length();
+               for(int i=0;i<taxLength;i++){
+                       if(tax[i] == ';'){
+               
+                               int openParen = taxon.find_first_of('(');
+                               int closeParen = taxon.find_last_of(')');
+                               
+                               string newtaxon, confidence;
+                               if ((openParen != string::npos) && (closeParen != string::npos)) {
+                                       newtaxon = taxon.substr(0, openParen); //rip off confidence
+                                       confidence = taxon.substr((openParen+1), (closeParen-openParen-1));  
+                               }else{
+                                       newtaxon = taxon;
+                                       confidence = "0";
+                               } 
+                               float con = 0;
+                               convert(confidence, con);
+                               
+                               map<string, float> temp;
+                               temp[newtaxon] = con;
+                               t.push_back(temp);
+                               
+                               taxon = "";
+                       }
+                       else{
+                               taxon += tax[i];
+                       }
+               }
+               
+               return t;
+       }
+       catch(exception& e) {
+               m->errorOut(e, "GetLineageCommand", "getTaxons");
+               exit(1);
+       }
+}
+/**************************************************************************************************/
 string GetLineageCommand::removeConfidences(string tax) {
        try {