5 * Created by westcott on 11/10/10.
6 * Copyright 2010 Schloss Lab. All rights reserved.
10 #include "getgroupscommand.h"
11 #include "sequence.hpp"
12 #include "listvector.hpp"
13 #include "sharedutilities.h"
15 //**********************************************************************************************************************
16 vector<string> GetGroupsCommand::setParameters(){
18 CommandParameter pfasta("fasta", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(pfasta);
19 CommandParameter pname("name", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(pname);
20 CommandParameter pgroup("group", "InputTypes", "", "", "none", "FNGLT", "none",false,true); parameters.push_back(pgroup);
21 CommandParameter plist("list", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(plist);
22 CommandParameter ptaxonomy("taxonomy", "InputTypes", "", "", "none", "FNGLT", "none",false,false); parameters.push_back(ptaxonomy);
23 CommandParameter paccnos("accnos", "InputTypes", "", "", "none", "none", "none",false,false); parameters.push_back(paccnos);
24 CommandParameter pgroups("groups", "String", "", "", "", "", "",false,false); parameters.push_back(pgroups);
25 CommandParameter pinputdir("inputdir", "String", "", "", "", "", "",false,false); parameters.push_back(pinputdir);
26 CommandParameter poutputdir("outputdir", "String", "", "", "", "", "",false,false); parameters.push_back(poutputdir);
28 vector<string> myArray;
29 for (int i = 0; i < parameters.size(); i++) { myArray.push_back(parameters[i].name); }
33 m->errorOut(e, "GetGroupsCommand", "setParameters");
37 //**********************************************************************************************************************
38 string GetGroupsCommand::getHelpString(){
40 string helpString = "";
41 helpString += "The get.groups command selects sequences from a specfic group or set of groups from the following file types: fasta, name, group, list, taxonomy.\n";
42 helpString += "It outputs a file containing the sequences in the those specified groups.\n";
43 helpString += "The get.groups command parameters are accnos, fasta, name, group, list, taxonomy and groups. The group parameter is required, unless you have a current group file.\n";
44 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";
45 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";
46 helpString += "The get.groups command should be in the following format: get.groups(accnos=yourAccnos, fasta=yourFasta, group=yourGroupFile).\n";
47 helpString += "Example get.groups(accnos=amazon.accnos, fasta=amazon.fasta, group=amazon.groups).\n";
48 helpString += "or get.groups(groups=pasture, fasta=amazon.fasta, group=amazon.groups).\n";
49 helpString += "Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n";
53 m->errorOut(e, "GetGroupsCommand", "getHelpString");
57 //**********************************************************************************************************************
58 GetGroupsCommand::GetGroupsCommand(){
60 abort = true; calledHelp = true;
62 vector<string> tempOutNames;
63 outputTypes["fasta"] = tempOutNames;
64 outputTypes["taxonomy"] = tempOutNames;
65 outputTypes["name"] = tempOutNames;
66 outputTypes["group"] = tempOutNames;
67 outputTypes["list"] = tempOutNames;
70 m->errorOut(e, "GetGroupsCommand", "GetGroupsCommand");
74 //**********************************************************************************************************************
75 GetGroupsCommand::GetGroupsCommand(string option) {
77 abort = false; calledHelp = false;
79 //allow user to run help
80 if(option == "help") { help(); abort = true; calledHelp = true; }
81 else if(option == "citation") { citation(); abort = true; calledHelp = true;}
84 vector<string> myArray = setParameters();
86 OptionParser parser(option);
87 map<string,string> parameters = parser.getParameters();
89 ValidParameters validParameter;
90 map<string,string>::iterator it;
92 //check to make sure all parameters are valid for command
93 for (it = parameters.begin(); it != parameters.end(); it++) {
94 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
97 //initialize outputTypes
98 vector<string> tempOutNames;
99 outputTypes["fasta"] = tempOutNames;
100 outputTypes["taxonomy"] = tempOutNames;
101 outputTypes["name"] = tempOutNames;
102 outputTypes["group"] = tempOutNames;
103 outputTypes["list"] = tempOutNames;
106 //if the user changes the output directory command factory will send this info to us in the output parameter
107 outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){ outputDir = ""; }
109 //if the user changes the input directory command factory will send this info to us in the output parameter
110 string inputDir = validParameter.validFile(parameters, "inputdir", false);
111 if (inputDir == "not found"){ inputDir = ""; }
114 it = parameters.find("fasta");
115 //user has given a template file
116 if(it != parameters.end()){
117 path = m->hasPath(it->second);
118 //if the user has not given a path then, add inputdir. else leave path alone.
119 if (path == "") { parameters["fasta"] = inputDir + it->second; }
122 it = parameters.find("accnos");
123 //user has given a template file
124 if(it != parameters.end()){
125 path = m->hasPath(it->second);
126 //if the user has not given a path then, add inputdir. else leave path alone.
127 if (path == "") { parameters["accnos"] = inputDir + it->second; }
130 it = parameters.find("list");
131 //user has given a template file
132 if(it != parameters.end()){
133 path = m->hasPath(it->second);
134 //if the user has not given a path then, add inputdir. else leave path alone.
135 if (path == "") { parameters["list"] = inputDir + it->second; }
138 it = parameters.find("name");
139 //user has given a template file
140 if(it != parameters.end()){
141 path = m->hasPath(it->second);
142 //if the user has not given a path then, add inputdir. else leave path alone.
143 if (path == "") { parameters["name"] = inputDir + it->second; }
146 it = parameters.find("group");
147 //user has given a template file
148 if(it != parameters.end()){
149 path = m->hasPath(it->second);
150 //if the user has not given a path then, add inputdir. else leave path alone.
151 if (path == "") { parameters["group"] = inputDir + it->second; }
154 it = parameters.find("taxonomy");
155 //user has given a template file
156 if(it != parameters.end()){
157 path = m->hasPath(it->second);
158 //if the user has not given a path then, add inputdir. else leave path alone.
159 if (path == "") { parameters["taxonomy"] = inputDir + it->second; }
164 //check for required parameters
165 accnosfile = validParameter.validFile(parameters, "accnos", true);
166 if (accnosfile == "not open") { abort = true; }
167 else if (accnosfile == "not found") { accnosfile = ""; }
168 else { m->setAccnosFile(accnosfile); }
170 fastafile = validParameter.validFile(parameters, "fasta", true);
171 if (fastafile == "not open") { abort = true; }
172 else if (fastafile == "not found") { fastafile = ""; }
173 else { m->setFastaFile(fastafile); }
175 namefile = validParameter.validFile(parameters, "name", true);
176 if (namefile == "not open") { abort = true; }
177 else if (namefile == "not found") { namefile = ""; }
178 else { m->setNameFile(namefile); }
180 groupfile = validParameter.validFile(parameters, "group", true);
181 if (groupfile == "not open") { abort = true; }
182 else if (groupfile == "not found") {
183 //if there is a current group file, use it
184 groupfile = m->getGroupFile();
185 if (groupfile != "") { m->mothurOut("Using " + groupfile + " as input file for the group parameter."); m->mothurOutEndLine(); }
186 else { m->mothurOut("You have no current groupfile and the group parameter is required."); m->mothurOutEndLine(); abort = true; }
187 }else { m->setGroupFile(groupfile); }
189 listfile = validParameter.validFile(parameters, "list", true);
190 if (listfile == "not open") { abort = true; }
191 else if (listfile == "not found") { listfile = ""; }
192 else { m->setListFile(listfile); }
194 taxfile = validParameter.validFile(parameters, "taxonomy", true);
195 if (taxfile == "not open") { abort = true; }
196 else if (taxfile == "not found") { taxfile = ""; }
197 else { m->setTaxonomyFile(taxfile); }
199 groups = validParameter.validFile(parameters, "groups", false);
200 if (groups == "not found") { groups = "all"; }
201 m->splitAtDash(groups, Groups);
204 if ((accnosfile == "") && (Groups.size() == 0)) { m->mothurOut("You must provide an accnos file or specify groups using the groups parameter."); m->mothurOutEndLine(); abort = true; }
206 if ((fastafile == "") && (namefile == "") && (groupfile == "") && (listfile == "") && (taxfile == "")) { m->mothurOut("You must provide at least one of the following: fasta, name, taxonomy, group or list."); m->mothurOutEndLine(); abort = true; }
210 catch(exception& e) {
211 m->errorOut(e, "GetGroupsCommand", "GetGroupsCommand");
215 //**********************************************************************************************************************
217 int GetGroupsCommand::execute(){
220 if (abort == true) { if (calledHelp) { return 0; } return 2; }
222 groupMap = new GroupMap(groupfile);
225 //get groups you want to remove
226 if (accnosfile != "") { readAccnos(); }
228 //make sure groups are valid
229 //takes care of user setting groupNames that are invalid or setting groups=all
230 SharedUtil* util = new SharedUtil();
231 util->setGroups(Groups, groupMap->namesOfGroups);
234 //fill names with names of sequences that are from the groups we want to remove
237 if (m->control_pressed) { delete groupMap; return 0; }
239 //read through the correct file and output lines you want to keep
240 if (namefile != "") { readName(); }
241 if (fastafile != "") { readFasta(); }
242 if (groupfile != "") { readGroup(); }
243 if (listfile != "") { readList(); }
244 if (taxfile != "") { readTax(); }
246 if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) { m->mothurRemove(outputNames[i]); } return 0; }
248 m->mothurOut("Selected " + toString(names.size()) + " sequences. From the groups: "); m->mothurOutEndLine();
249 for (int i = 0; i < Groups.size(); i++) { m->mothurOut(Groups[i]); m->mothurOut("\t" + toString(groupMap->getNumSeqs(Groups[i]))); m->mothurOutEndLine(); }
250 m->mothurOutEndLine();
252 if (outputNames.size() != 0) {
253 m->mothurOutEndLine();
254 m->mothurOut("Output File names: "); m->mothurOutEndLine();
255 for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i]); m->mothurOutEndLine(); }
256 m->mothurOutEndLine();
258 //set fasta file as new current fastafile
260 itTypes = outputTypes.find("fasta");
261 if (itTypes != outputTypes.end()) {
262 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setFastaFile(current); }
265 itTypes = outputTypes.find("name");
266 if (itTypes != outputTypes.end()) {
267 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setNameFile(current); }
270 itTypes = outputTypes.find("group");
271 if (itTypes != outputTypes.end()) {
272 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setGroupFile(current); }
275 itTypes = outputTypes.find("list");
276 if (itTypes != outputTypes.end()) {
277 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setListFile(current); }
280 itTypes = outputTypes.find("taxonomy");
281 if (itTypes != outputTypes.end()) {
282 if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setTaxonomyFile(current); }
289 catch(exception& e) {
290 m->errorOut(e, "GetGroupsCommand", "execute");
295 //**********************************************************************************************************************
296 int GetGroupsCommand::readFasta(){
298 string thisOutputDir = outputDir;
299 if (outputDir == "") { thisOutputDir += m->hasPath(fastafile); }
300 string outputFileName = thisOutputDir + m->getRootName(m->getSimpleName(fastafile)) + "pick" + m->getExtension(fastafile);
303 m->openOutputFile(outputFileName, out);
306 m->openInputFile(fastafile, in);
309 bool wroteSomething = false;
312 if (m->control_pressed) { in.close(); out.close(); m->mothurRemove(outputFileName); return 0; }
314 Sequence currSeq(in);
315 name = currSeq.getName();
318 //if this name is in the accnos file
319 if (names.count(name) != 0) {
320 wroteSomething = true;
322 currSeq.printSequence(out);
330 if (wroteSomething == false) { m->mothurOut("Your file does NOT contain sequences from the groups you wish to get."); m->mothurOutEndLine(); }
331 outputTypes["fasta"].push_back(outputFileName); outputNames.push_back(outputFileName);
336 catch(exception& e) {
337 m->errorOut(e, "GetGroupsCommand", "readFasta");
342 //**********************************************************************************************************************
343 int GetGroupsCommand::readList(){
345 string thisOutputDir = outputDir;
346 if (outputDir == "") { thisOutputDir += m->hasPath(listfile); }
347 string outputFileName = thisOutputDir + m->getRootName(m->getSimpleName(listfile)) + "pick" + m->getExtension(listfile);
350 m->openOutputFile(outputFileName, out);
353 m->openInputFile(listfile, in);
355 bool wroteSomething = false;
358 //read in list vector
361 //make a new list vector
363 newList.setLabel(list.getLabel());
366 for (int i = 0; i < list.getNumBins(); i++) {
367 if (m->control_pressed) { in.close(); out.close(); m->mothurRemove(outputFileName); return 0; }
369 //parse out names that are in accnos file
370 string binnames = list.get(i);
372 string newNames = "";
373 while (binnames.find_first_of(',') != -1) {
374 string name = binnames.substr(0,binnames.find_first_of(','));
375 binnames = binnames.substr(binnames.find_first_of(',')+1, binnames.length());
377 //if that name is in the .accnos file, add it
378 if (names.count(name) != 0) { newNames += name + ","; }
382 if (names.count(binnames) != 0) { newNames += binnames + ","; }
384 //if there are names in this bin add to new list
385 if (newNames != "") {
386 newNames = newNames.substr(0, newNames.length()-1); //rip off extra comma
387 newList.push_back(newNames);
391 //print new listvector
392 if (newList.getNumBins() != 0) {
393 wroteSomething = true;
402 if (wroteSomething == false) { m->mothurOut("Your file does NOT contain sequences from the groups you wish to get."); m->mothurOutEndLine(); }
403 outputTypes["list"].push_back(outputFileName); outputNames.push_back(outputFileName);
408 catch(exception& e) {
409 m->errorOut(e, "GetGroupsCommand", "readList");
413 //**********************************************************************************************************************
414 int GetGroupsCommand::readName(){
416 string thisOutputDir = outputDir;
417 if (outputDir == "") { thisOutputDir += m->hasPath(namefile); }
418 string outputFileName = thisOutputDir + m->getRootName(m->getSimpleName(namefile)) + "pick" + m->getExtension(namefile);
421 m->openOutputFile(outputFileName, out);
424 m->openInputFile(namefile, in);
425 string name, firstCol, secondCol;
427 bool wroteSomething = false;
430 if (m->control_pressed) { in.close(); out.close(); m->mothurRemove(outputFileName); return 0; }
432 in >> firstCol; m->gobble(in);
435 vector<string> parsedNames;
436 m->splitAtComma(secondCol, parsedNames);
438 vector<string> validSecond; validSecond.clear();
439 for (int i = 0; i < parsedNames.size(); i++) {
440 if (names.count(parsedNames[i]) != 0) {
441 validSecond.push_back(parsedNames[i]);
445 //if the name in the first column is in the set then print it and any other names in second column also in set
446 if (names.count(firstCol) != 0) {
448 wroteSomething = true;
450 out << firstCol << '\t';
452 //you know you have at least one valid second since first column is valid
453 for (int i = 0; i < validSecond.size()-1; i++) { out << validSecond[i] << ','; }
454 out << validSecond[validSecond.size()-1] << endl;
456 //make first name in set you come to first column and then add the remaining names to second column
459 //you want part of this row
460 if (validSecond.size() != 0) {
462 wroteSomething = true;
464 out << validSecond[0] << '\t';
466 //you know you have at least one valid second since first column is valid
467 for (int i = 0; i < validSecond.size()-1; i++) { out << validSecond[i] << ','; }
468 out << validSecond[validSecond.size()-1] << endl;
477 if (wroteSomething == false) { m->mothurOut("Your file does NOT contain sequences from the groups you wish to get."); m->mothurOutEndLine(); }
478 outputTypes["name"].push_back(outputFileName); outputNames.push_back(outputFileName);
482 catch(exception& e) {
483 m->errorOut(e, "GetGroupsCommand", "readName");
488 //**********************************************************************************************************************
489 int GetGroupsCommand::readGroup(){
491 string thisOutputDir = outputDir;
492 if (outputDir == "") { thisOutputDir += m->hasPath(groupfile); }
493 string outputFileName = thisOutputDir + m->getRootName(m->getSimpleName(groupfile)) + "pick" + m->getExtension(groupfile);
496 m->openOutputFile(outputFileName, out);
499 m->openInputFile(groupfile, in);
502 bool wroteSomething = false;
505 if (m->control_pressed) { in.close(); out.close(); m->mothurRemove(outputFileName); return 0; }
507 in >> name; //read from first column
508 in >> group; //read from second column
510 //if this name is in the accnos file
511 if (names.count(name) != 0) {
512 wroteSomething = true;
513 out << name << '\t' << group << endl;
521 if (wroteSomething == false) { m->mothurOut("Your file does NOT contain sequences from the groups you wish to get."); m->mothurOutEndLine(); }
522 outputTypes["group"].push_back(outputFileName); outputNames.push_back(outputFileName);
526 catch(exception& e) {
527 m->errorOut(e, "GetGroupsCommand", "readGroup");
531 //**********************************************************************************************************************
532 int GetGroupsCommand::readTax(){
534 string thisOutputDir = outputDir;
535 if (outputDir == "") { thisOutputDir += m->hasPath(taxfile); }
536 string outputFileName = thisOutputDir + m->getRootName(m->getSimpleName(taxfile)) + "pick" + m->getExtension(taxfile);
538 m->openOutputFile(outputFileName, out);
541 m->openInputFile(taxfile, in);
544 bool wroteSomething = false;
547 if (m->control_pressed) { in.close(); out.close(); m->mothurRemove(outputFileName); return 0; }
549 in >> name; //read from first column
550 in >> tax; //read from second column
552 //if this name is in the accnos file
553 if (names.count(name) != 0) {
554 wroteSomething = true;
555 out << name << '\t' << tax << endl;
563 if (wroteSomething == false) { m->mothurOut("Your file does NOT contain sequences from the groups you wish to get."); m->mothurOutEndLine(); }
564 outputTypes["taxonomy"].push_back(outputFileName); outputNames.push_back(outputFileName);
568 catch(exception& e) {
569 m->errorOut(e, "GetGroupsCommand", "readTax");
573 //**********************************************************************************************************************
574 void GetGroupsCommand::readAccnos(){
579 m->openInputFile(accnosfile, in);
585 Groups.push_back(name);
592 catch(exception& e) {
593 m->errorOut(e, "GetGroupsCommand", "readAccnos");
597 //**********************************************************************************************************************
598 int GetGroupsCommand::fillNames(){
600 vector<string> seqs = groupMap->getNamesSeqs();
602 for (int i = 0; i < seqs.size(); i++) {
604 if (m->control_pressed) { return 0; }
606 string group = groupMap->getGroup(seqs[i]);
608 if (m->inUsersGroups(group, Groups)) {
609 names.insert(seqs[i]);
615 catch(exception& e) {
616 m->errorOut(e, "GetGroupsCommand", "fillNames");
621 //**********************************************************************************************************************