]> git.donarmstrong.com Git - mothur.git/blobdiff - binsequencecommand.cpp
adding mothurout.h and .cpp to repo
[mothur.git] / binsequencecommand.cpp
index a291caae25782de3d9af111fc149011c77d72eea..1601f32873ed6c8eefe41608ceda199a6fa5b5f5 100644 (file)
 #include "binsequencecommand.h"
 
 //**********************************************************************************************************************
-BinSeqCommand::BinSeqCommand(string option){
+BinSeqCommand::BinSeqCommand(string option) {
        try {
                globaldata = GlobalData::getInstance();
                abort = false;
                allLines = 1;
-               lines.clear();
                labels.clear();
                
                //allow user to run help
@@ -23,36 +22,72 @@ BinSeqCommand::BinSeqCommand(string option){
                
                else {
                        //valid paramters for this command
-                       string AlignArray[] =  {"fasta","line","label","name", "group"};
+                       string AlignArray[] =  {"fasta","label","name", "group","outputdir","inputdir"};
                        vector<string> myArray (AlignArray, AlignArray+(sizeof(AlignArray)/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 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(globaldata->getListFile()); //if user entered a file with a path then preserve it  
+                       }
+
+                       
                        //make sure the user has already run the read.otu command
-                       if (globaldata->getListFile() == "") { cout << "You must read a listfile before running the bin.seqs command." << endl; abort = true; }
+                       if (globaldata->getListFile() == "") { 
+                               m->mothurOut("You must read a listfile before running the bin.seqs command."); 
+                               m->mothurOutEndLine(); 
+                               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("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;             }
+                               }
+                               
+                               it = parameters.find("group");
+                               //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["group"] = inputDir + it->second;            }
+                               }
+                       }
+
                        
                        //check for required parameters
                        fastafile = validParameter.validFile(parameters, "fasta", true);
-                       if (fastafile == "not found") { cout << "fasta is a required parameter for the bin.seqs command." << endl; abort = true; }
+                       if (fastafile == "not found") { m->mothurOut("fasta is a required parameter for the bin.seqs command.");  m->mothurOutEndLine(); abort = true; }
                        else if (fastafile == "not open") { abort = true; }     
                
                        //check for optional parameter and set defaults
                        // ...at some point should added some additional type checking...
-                       line = validParameter.validFile(parameters, "line", false);                             
-                       if (line == "not found") { line = "";  }
-                       else { 
-                               if(line != "all") {  splitAtDash(line, lines);  allLines = 0;  }
-                               else { allLines = 1;  }
-                       }
                        
                        label = validParameter.validFile(parameters, "label", false);                   
                        if (label == "not found") { label = ""; }
@@ -61,13 +96,10 @@ BinSeqCommand::BinSeqCommand(string option){
                                else { allLines = 1;  }
                        }
                        
-                       //make sure user did not use both the line and label parameters
-                       if ((line != "") && (label != "")) { cout << "You cannot use both the line and label parameters at the same time. " << endl; abort = true; }
-                       //if the user has not specified any line or labels use the ones from read.otu
-                       else if ((line == "") && (label == "")) {  
+                       //if the user has not specified any labels use the ones from read.otu
+                       if (label == "") {  
                                allLines = globaldata->allLines; 
                                labels = globaldata->labels; 
-                               lines = globaldata->lines;
                        }
                        
                        namesfile = validParameter.validFile(parameters, "name", true);
@@ -83,47 +115,39 @@ BinSeqCommand::BinSeqCommand(string option){
                                fasta = new FastaMap();
                                if (groupfile != "") {
                                        groupMap = new GroupMap(groupfile);
-                                       groupMap->readMap();
+                                       
+                                       int error = groupMap->readMap();
+                                       if (error == 1) { delete groupMap; abort = true; }
                                }
                        }
        
                }
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the BinSeqCommand class Function BinSeqCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               m->errorOut(e, "BinSeqCommand", "BinSeqCommand");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the BinSeqCommand class function BinSeqCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }       
 }
 //**********************************************************************************************************************
 
 void BinSeqCommand::help(){
        try {
-               cout << "The bin.seqs command can only be executed after a successful read.otu command of a listfile." << "\n";
-               cout << "The bin.seqs command parameters are fasta, name, line, label and group.  The fasta parameter is required, and you may not use line and label at the same time." << "\n";
-               cout << "The line and label allow you to select what distance levels you would like a output files created for, and are separated by dashes." << "\n";
-               cout << "The bin.seqs command should be in the following format: bin.seqs(fasta=yourFastaFile, name=yourNamesFile, group=yourGroupFile, line=yourLines, label=yourLabels)." << "\n";
-               cout << "Example bin.seqs(fasta=amazon.fasta, group=amazon.groups, line=1-3-5, name=amazon.names)." << "\n";
-               cout << "The default value for line and label are all lines in your inputfile." << "\n";
-               cout << "The bin.seqs command outputs a .fasta file for each distance you specify appending the OTU number to each name." << "\n";
-               cout << "If you provide a groupfile, then it also appends the sequences group to the name." << "\n";
-               cout << "Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFastaFile)." << "\n" << "\n";
+               m->mothurOut("The bin.seqs command can only be executed after a successful read.otu command of a listfile.\n");
+               m->mothurOut("The bin.seqs command parameters are fasta, name, label and group.  The fasta parameter is required.\n");
+               m->mothurOut("The label parameter allows you to select what distance levels you would like a output files created for, and are separated by dashes.\n");
+               m->mothurOut("The bin.seqs command should be in the following format: bin.seqs(fasta=yourFastaFile, name=yourNamesFile, group=yourGroupFile, label=yourLabels).\n");
+               m->mothurOut("Example bin.seqs(fasta=amazon.fasta, group=amazon.groups, name=amazon.names).\n");
+               m->mothurOut("The default value for label is all lines in your inputfile.\n");
+               m->mothurOut("The bin.seqs command outputs a .fasta file for each distance you specify appending the OTU number to each name.\n");
+               m->mothurOut("If you provide a groupfile, then it also appends the sequences group to the name.\n");
+               m->mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFastaFile).\n\n");
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the BinSeqCommand class Function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               m->errorOut(e, "BinSeqCommand", "help");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the BinSeqCommand class function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }       
 }
 
-
-
 //**********************************************************************************************************************
 
 BinSeqCommand::~BinSeqCommand(){
@@ -143,7 +167,6 @@ int BinSeqCommand::execute(){
        try {
                if (abort == true) {    return 0;       }
        
-               int count = 1;
                int error = 0;
                
                //read fastafile
@@ -158,6 +181,7 @@ int BinSeqCommand::execute(){
                        readNamesFile();
                }
                
+               
                //read list file
                read = new ReadOTUFile(globaldata->getListFile());      
                read->read(&*globaldata); 
@@ -166,41 +190,44 @@ int BinSeqCommand::execute(){
                list = globaldata->gListVector;
                string lastLabel = list->getLabel();
                
+               if (m->control_pressed) {  return 0; }
+               
                //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
                set<string> processedLabels;
                set<string> userLabels = labels;
-               set<int> userLines = lines;
 
                                
-               while((list != NULL) && ((allLines == 1) || (userLabels.size() != 0) || (userLines.size() != 0))) {
+               while((list != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
                        
-                       if(allLines == 1 || lines.count(count) == 1 || labels.count(list->getLabel()) == 1){
+                       if(allLines == 1 || labels.count(list->getLabel()) == 1){
                                
-                               error = process(list, count);   
-                               if (error == 1) { return 0; }   
+                               error = process(list);  
+                               if (error == 1) { for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str());         } return 0; }   
                                                        
                                processedLabels.insert(list->getLabel());
                                userLabels.erase(list->getLabel());
-                               userLines.erase(count);
                        }
                        
                        if ((anyLabelsToProcess(list->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+                               string saveLabel = list->getLabel();
+                               
                                delete list;
                                list = input->getListVector(lastLabel);
                                
-                               error = process(list, count);   
-                               if (error == 1) { return 0; }
+                               error = process(list);  
+                               if (error == 1) { for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str());         } return 0; }
                                                                                                        
                                processedLabels.insert(list->getLabel());
                                userLabels.erase(list->getLabel());
                                
+                               //restore real lastlabel to save below
+                               list->setLabel(saveLabel);
                        }
                        
                        lastLabel = list->getLabel();                   
                        
                        delete list;
                        list = input->getListVector();
-                       count++;
                }
                
                
@@ -208,36 +235,38 @@ int BinSeqCommand::execute(){
                set<string>::iterator it;
                bool needToRun = false;
                for (it = userLabels.begin(); it != userLabels.end(); it++) {  
-                       cout << "Your file does not include the label "<< *it
+                       m->mothurOut("Your file does not include the label " + *it)
                        if (processedLabels.count(lastLabel) != 1) {
-                               cout << ". I will use " << lastLabel << "." << endl;
+                               m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
                                needToRun = true;
                        }else {
-                               cout << ". Please refer to " << lastLabel << "." << endl;
+                               m->mothurOut(". Please refer to " + lastLabel + ".");  m->mothurOutEndLine();
                        }
                }
                
-               //run last line if you need to
+               //run last label if you need to
                if (needToRun == true)  {
-                       delete list;
+                       if (list != NULL) {             delete list;    }
                        list = input->getListVector(lastLabel);
                                
-                       error = process(list, count);   
-                       if (error == 1) { return 0; }
+                       error = process(list);  
+                       if (error == 1) { for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str());         } return 0; }
                        
                        delete list;  
                }
                
+               m->mothurOutEndLine();
+               m->mothurOut("Output File Names: "); m->mothurOutEndLine();
+               for (int i = 0; i < outputNames.size(); i++) {  m->mothurOut(outputNames[i]); m->mothurOutEndLine();    }
+               m->mothurOutEndLine();
+
+               
                return 0;
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the BinSeqCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               m->errorOut(e, "BinSeqCommand", "execute");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the BinSeqCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }       
 }
 
 //**********************************************************************************************************************
@@ -269,27 +298,29 @@ void BinSeqCommand::readNamesFile() {
 
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the BinSeqCommand class Function readNamesFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               m->errorOut(e, "BinSeqCommand", "readNamesFile");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the BinSeqCommand class function readNamesFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }       
 }
 //**********************************************************************************************************************
 //return 1 if error, 0 otherwise
-int BinSeqCommand::process(ListVector* list, int count) {
+int BinSeqCommand::process(ListVector* list) {
        try {
                                string binnames, name, sequence;
-                               string outputFileName = getRootName(globaldata->getListFile()) + list->getLabel() + ".fasta";
+                               
+                               string outputFileName = outputDir + getRootName(getSimpleName(globaldata->getListFile())) + list->getLabel() + ".fasta";
                                openOutputFile(outputFileName, out);
+                               
+                               //save to output list of output file names
+                               outputNames.push_back(outputFileName);
 
-                               cout << list->getLabel() << '\t' << count << endl;
+                               m->mothurOut(list->getLabel()); m->mothurOutEndLine();
                                
                                //for each bin in the list vector
                                for (int i = 0; i < list->size(); i++) {
-
+                                       
+                                       if (m->control_pressed) {  return 1; }
+                                       
                                        binnames = list->get(i);
                                        while (binnames.find_first_of(',') != -1) { 
                                                name = binnames.substr(0,binnames.find_first_of(','));
@@ -306,8 +337,7 @@ int BinSeqCommand::process(ListVector* list, int count) {
                                                        }else {//if you do have groups
                                                                string group = groupMap->getGroup(name);
                                                                if (group == "not found") {  
-                                                                       cout << name << " is missing from your group file. Please correct. " << endl;
-                                                                       remove(outputFileName.c_str());
+                                                                       m->mothurOut(name + " is missing from your group file. Please correct. ");  m->mothurOutEndLine();
                                                                        return 1;
                                                                }else{
                                                                        name = name + "|" + group + "|" + toString(i+1);
@@ -316,8 +346,7 @@ int BinSeqCommand::process(ListVector* list, int count) {
                                                                }
                                                        }
                                                }else { 
-                                                       cout << name << " is missing from your fasta or name file. Please correct. " << endl; 
-                                                       remove(outputFileName.c_str());
+                                                       m->mothurOut(name + " is missing from your fasta or name file. Please correct. "); m->mothurOutEndLine();
                                                        return 1;
                                                }
                                                
@@ -334,8 +363,7 @@ int BinSeqCommand::process(ListVector* list, int count) {
                                                }else {//if you do have groups
                                                        string group = groupMap->getGroup(binnames);
                                                        if (group == "not found") {  
-                                                               cout << binnames << " is missing from your group file. Please correct. " << endl;
-                                                               remove(outputFileName.c_str());
+                                                               m->mothurOut(binnames + " is missing from your group file. Please correct. "); m->mothurOutEndLine();
                                                                return 1;
                                                        }else{
                                                                binnames = binnames + "|" + group + "|" + toString(i+1);
@@ -344,8 +372,7 @@ int BinSeqCommand::process(ListVector* list, int count) {
                                                        }
                                                }
                                        }else { 
-                                               cout << binnames << " is missing from your fasta or name file. Please correct. " << endl; 
-                                               remove(outputFileName.c_str());
+                                               m->mothurOut(binnames + " is missing from your fasta or name file. Please correct. "); m->mothurOutEndLine();
                                                return 1;
                                        }
                                }
@@ -355,13 +382,9 @@ int BinSeqCommand::process(ListVector* list, int count) {
 
        }
        catch(exception& e) {
-               cout << "Standard Error: " << e.what() << " has occurred in the BinSeqCommand class Function readNamesFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+               m->errorOut(e, "BinSeqCommand", "process");
                exit(1);
        }
-       catch(...) {
-               cout << "An unknown error has occurred in the BinSeqCommand class function readNamesFile. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
-               exit(1);
-       }       
 }
 //**********************************************************************************************************************