]> git.donarmstrong.com Git - mothur.git/blobdiff - removeotuscommand.cpp
changed reading of name file to use buffered reads. note the splitAtWhiteSpace functi...
[mothur.git] / removeotuscommand.cpp
index f1ef4ac5a80c7e2782843349d1433680b38bda45..25ed99eacbbd3c6dcbcad18daf5fef44ec13b746 100644 (file)
 #include "inputdata.h"
 #include "sharedutilities.h"
 
-
 //**********************************************************************************************************************
-vector<string> RemoveOtusCommand::getValidParameters(){        
+vector<string> RemoveOtusCommand::setParameters(){     
        try {
-               string Array[] =  { "group", "accnos","label", "groups","list","outputdir","inputdir" };
-               vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+               CommandParameter pgroup("group", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(pgroup);
+               CommandParameter plist("list", "InputTypes", "", "", "none", "none", "none",false,true); parameters.push_back(plist);
+               CommandParameter paccnos("accnos", "InputTypes", "", "", "none", "none", "none",false,false); parameters.push_back(paccnos);
+               CommandParameter pgroups("groups", "String", "", "", "", "", "",false,false); parameters.push_back(pgroups);
+               CommandParameter plabel("label", "String", "", "", "", "", "",false,false); parameters.push_back(plabel);
+               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, "RemoveOtusCommand", "getValidParameters");
+               m->errorOut(e, "RemoveOtusCommand", "setParameters");
                exit(1);
        }
 }
 //**********************************************************************************************************************
-RemoveOtusCommand::RemoveOtusCommand(){        
+string RemoveOtusCommand::getHelpString(){     
        try {
-               abort = true; calledHelp = true; 
-               vector<string> tempOutNames;
-               outputTypes["group"] = tempOutNames;
-               outputTypes["list"] = tempOutNames;
+               string helpString = "";
+               helpString += "The remove.otus command removes otus containing sequences from a specfic group or set of groups.\n";
+               helpString += "It outputs a new list file containing the otus containing sequences NOT from in the those specified groups.\n";
+               helpString += "The remove.otus command parameters are accnos, group, list, label and groups. The group and list parameters are required, unless you have valid current files.\n";
+               helpString += "You must also provide an accnos containing the list of groups to get or set the groups parameter to the groups you wish to select.\n";
+               helpString += "The groups parameter allows you to specify which of the groups in your groupfile you would like.  You can separate group names with dashes.\n";
+               helpString += "The label parameter allows you to specify which distance you want to process.\n";
+               helpString += "The remove.otus command should be in the following format: remove.otus(accnos=yourAccnos, list=yourListFile, group=yourGroupFile, label=yourLabel).\n";
+               helpString += "Example remove.otus(accnos=amazon.accnos, list=amazon.fn.list, group=amazon.groups, label=0.03).\n";
+               helpString += "or remove.otus(groups=pasture, list=amazon.fn.list, amazon.groups, label=0.03).\n";
+               helpString += "Note: No spaces between parameter labels (i.e. list), '=' and parameters (i.e.yourListFile).\n";
+               return helpString;
        }
        catch(exception& e) {
-               m->errorOut(e, "RemoveOtusCommand", "RemoveOtusCommand");
+               m->errorOut(e, "RemoveOtusCommand", "getHelpString");
                exit(1);
        }
 }
-//**********************************************************************************************************************
-vector<string> RemoveOtusCommand::getRequiredParameters(){     
-       try {
-               string Array[] =  {"group","label", "list"};
-               vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
-               return myArray;
-       }
-       catch(exception& e) {
-               m->errorOut(e, "RemoveOtusCommand", "getRequiredParameters");
-               exit(1);
-       }
-}
-//**********************************************************************************************************************
-vector<string> RemoveOtusCommand::getRequiredFiles(){  
+
+///**********************************************************************************************************************
+RemoveOtusCommand::RemoveOtusCommand(){        
        try {
-               vector<string> myArray;
-               return myArray;
+               abort = true; calledHelp = true; 
+               setParameters();
+               vector<string> tempOutNames;
+               outputTypes["group"] = tempOutNames;
+               outputTypes["list"] = tempOutNames;
        }
        catch(exception& e) {
-               m->errorOut(e, "RemoveOtusCommand", "getRequiredFiles");
+               m->errorOut(e, "RemoveOtusCommand", "RemoveOtusCommand");
                exit(1);
        }
 }
+
 //**********************************************************************************************************************
 RemoveOtusCommand::RemoveOtusCommand(string option)  {
        try {
@@ -67,11 +75,10 @@ RemoveOtusCommand::RemoveOtusCommand(string option)  {
                
                //allow user to run help
                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[] =  { "group", "accnos","label", "groups", "list","outputdir","inputdir" };
-                       vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+                       vector<string> myArray = setParameters();
                        
                        OptionParser parser(option);
                        map<string,string> parameters = parser.getParameters();
@@ -127,15 +134,24 @@ RemoveOtusCommand::RemoveOtusCommand(string option)  {
                        //check for required parameters
                        accnosfile = validParameter.validFile(parameters, "accnos", true);
                        if (accnosfile == "not open") { abort = true; }
-                       else if (accnosfile == "not found") {  accnosfile = ""; }       
+                       else if (accnosfile == "not found") {  accnosfile = ""; }
+                       else { m->setAccnosFile(accnosfile); }
                        
                        groupfile = validParameter.validFile(parameters, "group", true);
                        if (groupfile == "not open") { abort = true; }
-                       else if (groupfile == "not found") {  groupfile = "";  m->mothurOut("You must provide a group file."); m->mothurOutEndLine(); abort = true; }   
+                       else if (groupfile == "not found") {                            
+                               groupfile = m->getGroupFile(); 
+                               if (groupfile != "") { m->mothurOut("Using " + groupfile + " as input file for the group parameter."); m->mothurOutEndLine(); }
+                               else {  m->mothurOut("You have no current group file and the group parameter is required."); m->mothurOutEndLine(); abort = true; }
+                       }else { m->setGroupFile(groupfile); }   
                        
                        listfile = validParameter.validFile(parameters, "list", true);
                        if (listfile == "not open") { abort = true; }
-                       else if (listfile == "not found") {  listfile = ""; m->mothurOut("You must provide a list file."); m->mothurOutEndLine(); abort = true; }       
+                       else if (listfile == "not found") {                             
+                               listfile = m->getListFile(); 
+                               if (listfile != "") { m->mothurOut("Using " + listfile + " as input file for the list parameter."); m->mothurOutEndLine(); }
+                               else {  m->mothurOut("You have no current list file and the list parameter is required."); m->mothurOutEndLine(); abort = true; }
+                       }else { m->setListFile(listfile); }     
                        
                        groups = validParameter.validFile(parameters, "groups", false);                 
                        if (groups == "not found") { groups = ""; }
@@ -144,7 +160,7 @@ RemoveOtusCommand::RemoveOtusCommand(string option)  {
                        }
                        
                        label = validParameter.validFile(parameters, "label", false);                   
-                       if (label == "not found") { label = ""; m->mothurOut("You must provide a label to process."); m->mothurOutEndLine(); abort = true; }    
+                       if (label == "not found") { label = ""; m->mothurOut("You did not provide a label, I will use the first label in your inputfile."); m->mothurOutEndLine(); label=""; }  
                        
                        if ((accnosfile == "") && (Groups.size() == 0)) { m->mothurOut("You must provide an accnos file or specify groups using the groups parameter."); m->mothurOutEndLine(); abort = true; }
                }
@@ -157,27 +173,6 @@ RemoveOtusCommand::RemoveOtusCommand(string option)  {
 }
 //**********************************************************************************************************************
 
-void RemoveOtusCommand::help(){
-       try {
-               m->mothurOut("The remove.otus command removes otus containing sequences from a specfic group or set of groups.\n");
-               m->mothurOut("It outputs a new list file containing the otus containing sequences NOT from in the those specified groups.\n");
-               m->mothurOut("The remove.otus command parameters are accnos, group, list, label and groups. The group, list and label parameters are required.\n");
-               m->mothurOut("You must also provide an accnos containing the list of groups to get or set the groups parameter to the groups you wish to select.\n");
-               m->mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like.  You can separate group names with dashes.\n");
-               m->mothurOut("The label parameter allows you to specify which distance you want to process.\n");
-               m->mothurOut("The remove.otus command should be in the following format: remove.otus(accnos=yourAccnos, list=yourListFile, group=yourGroupFile, label=yourLabel).\n");
-               m->mothurOut("Example remove.otus(accnos=amazon.accnos, list=amazon.fn.list, group=amazon.groups, label=0.03).\n");
-               m->mothurOut("or remove.otus(groups=pasture, list=amazon.fn.list, amazon.groups, label=0.03).\n");
-               m->mothurOut("Note: No spaces between parameter labels (i.e. list), '=' and parameters (i.e.yourListFile).\n\n");
-       }
-       catch(exception& e) {
-               m->errorOut(e, "RemoveOtusCommand", "help");
-               exit(1);
-       }
-}
-
-//**********************************************************************************************************************
-
 int RemoveOtusCommand::execute(){
        try {
                
@@ -192,7 +187,8 @@ int RemoveOtusCommand::execute(){
                //make sure groups are valid
                //takes care of user setting groupNames that are invalid or setting groups=all
                SharedUtil* util = new SharedUtil();
-               util->setGroups(Groups, groupMap->namesOfGroups);
+               vector<string> allGroups = groupMap->getNamesOfGroups();
+               util->setGroups(Groups, allGroups);
                delete util;
                
                if (m->control_pressed) { delete groupMap; return 0; }
@@ -200,7 +196,7 @@ int RemoveOtusCommand::execute(){
                //read through the list file keeping any otus that contain any sequence from the groups selected
                readListGroup();
                
-               if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) {        remove(outputNames[i].c_str()); } return 0; }
+               if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) {        m->mothurRemove(outputNames[i]); } return 0; }
                
                if (outputNames.size() != 0) {
                        m->mothurOutEndLine();
@@ -250,6 +246,9 @@ int RemoveOtusCommand::readListGroup(){
                ListVector* list = input->getListVector();
                string lastLabel = list->getLabel();
                
+               //using first label seen if none is provided
+               if (label == "") { label = lastLabel; }
+               
                //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
                set<string> labels; labels.insert(label);
                set<string> processedLabels;
@@ -260,7 +259,7 @@ int RemoveOtusCommand::readListGroup(){
                //as long as you are not at the end of the file or done wih the lines you want
                while((list != NULL) && (userLabels.size() != 0)) {
                        
-                       if (m->control_pressed) {  delete list; delete input; out.close();  outGroup.close(); remove(outputFileName.c_str());  remove(outputGroupFileName.c_str());return 0;  }
+                       if (m->control_pressed) {  delete list; delete input; out.close();  outGroup.close(); m->mothurRemove(outputFileName);  m->mothurRemove(outputGroupFileName);return 0;  }
                        
                        if(labels.count(list->getLabel()) == 1){
                                processList(list, groupMap, out, outGroup, wroteSomething);
@@ -294,7 +293,7 @@ int RemoveOtusCommand::readListGroup(){
                }
                
                
-               if (m->control_pressed) {  if (list != NULL) { delete list; } delete input; out.close(); outGroup.close(); remove(outputFileName.c_str());  remove(outputGroupFileName.c_str()); return 0;  }
+               if (m->control_pressed) {  if (list != NULL) { delete list; } delete input; out.close(); outGroup.close(); m->mothurRemove(outputFileName);  m->mothurRemove(outputGroupFileName); return 0;  }
                
                //output error messages about any remaining user labels
                set<string>::iterator it;