2 * removeseqscommand.cpp
5 * Created by Sarah Westcott on 7/8/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "removeseqscommand.h"
11 #include "sequence.hpp"
12 #include "listvector.hpp"
14 //**********************************************************************************************************************
16 RemoveSeqsCommand::RemoveSeqsCommand(string option) {
20 //allow user to run help
21 if(option == "help") { help(); abort = true; }
24 //valid paramters for this command
25 string Array[] = {"fasta","name", "group", "alignreport", "accnos", "list","taxonomy","outputdir","inputdir", "dups" };
26 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
28 OptionParser parser(option);
29 map<string,string> parameters = parser.getParameters();
31 ValidParameters validParameter;
32 map<string,string>::iterator it;
34 //check to make sure all parameters are valid for command
35 for (it = parameters.begin(); it != parameters.end(); it++) {
36 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
39 //if the user changes the output directory command factory will send this info to us in the output parameter
40 outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){ outputDir = ""; }
42 //if the user changes the input directory command factory will send this info to us in the output parameter
43 string inputDir = validParameter.validFile(parameters, "inputdir", false);
44 if (inputDir == "not found"){ inputDir = ""; }
47 it = parameters.find("alignreport");
48 //user has given a template file
49 if(it != parameters.end()){
50 path = hasPath(it->second);
51 //if the user has not given a path then, add inputdir. else leave path alone.
52 if (path == "") { parameters["alignreport"] = inputDir + it->second; }
55 it = parameters.find("fasta");
56 //user has given a template file
57 if(it != parameters.end()){
58 path = hasPath(it->second);
59 //if the user has not given a path then, add inputdir. else leave path alone.
60 if (path == "") { parameters["fasta"] = inputDir + it->second; }
63 it = parameters.find("accnos");
64 //user has given a template file
65 if(it != parameters.end()){
66 path = hasPath(it->second);
67 //if the user has not given a path then, add inputdir. else leave path alone.
68 if (path == "") { parameters["accnos"] = inputDir + it->second; }
71 it = parameters.find("list");
72 //user has given a template file
73 if(it != parameters.end()){
74 path = hasPath(it->second);
75 //if the user has not given a path then, add inputdir. else leave path alone.
76 if (path == "") { parameters["list"] = inputDir + it->second; }
79 it = parameters.find("name");
80 //user has given a template file
81 if(it != parameters.end()){
82 path = hasPath(it->second);
83 //if the user has not given a path then, add inputdir. else leave path alone.
84 if (path == "") { parameters["name"] = inputDir + it->second; }
87 it = parameters.find("group");
88 //user has given a template file
89 if(it != parameters.end()){
90 path = hasPath(it->second);
91 //if the user has not given a path then, add inputdir. else leave path alone.
92 if (path == "") { parameters["group"] = inputDir + it->second; }
95 it = parameters.find("taxonomy");
96 //user has given a template file
97 if(it != parameters.end()){
98 path = hasPath(it->second);
99 //if the user has not given a path then, add inputdir. else leave path alone.
100 if (path == "") { parameters["taxonomy"] = inputDir + it->second; }
105 //check for required parameters
106 accnosfile = validParameter.validFile(parameters, "accnos", true);
107 if (accnosfile == "not open") { abort = true; }
108 else if (accnosfile == "not found") { accnosfile = ""; m->mothurOut("You must provide an accnos file."); m->mothurOutEndLine(); abort = true; }
110 fastafile = validParameter.validFile(parameters, "fasta", true);
111 if (fastafile == "not open") { abort = true; }
112 else if (fastafile == "not found") { fastafile = ""; }
114 namefile = validParameter.validFile(parameters, "name", true);
115 if (namefile == "not open") { abort = true; }
116 else if (namefile == "not found") { namefile = ""; }
118 groupfile = validParameter.validFile(parameters, "group", true);
119 if (groupfile == "not open") { abort = true; }
120 else if (groupfile == "not found") { groupfile = ""; }
122 alignfile = validParameter.validFile(parameters, "alignreport", true);
123 if (alignfile == "not open") { abort = true; }
124 else if (alignfile == "not found") { alignfile = ""; }
126 listfile = validParameter.validFile(parameters, "list", true);
127 if (listfile == "not open") { abort = true; }
128 else if (listfile == "not found") { listfile = ""; }
130 taxfile = validParameter.validFile(parameters, "taxonomy", true);
131 if (taxfile == "not open") { abort = true; }
132 else if (taxfile == "not found") { taxfile = ""; }
135 string usedDups = "true";
136 string temp = validParameter.validFile(parameters, "dups", false); if (temp == "not found") { temp = "false"; usedDups = ""; }
139 if ((fastafile == "") && (namefile == "") && (groupfile == "") && (alignfile == "") && (listfile == "") && (taxfile == "")) { m->mothurOut("You must provide at least one of the following: fasta, name, group, taxonomy, alignreport or list."); m->mothurOutEndLine(); abort = true; }
141 if ((usedDups != "") && (namefile == "")) { m->mothurOut("You may only use dups with the name option."); m->mothurOutEndLine(); abort = true; }
145 catch(exception& e) {
146 m->errorOut(e, "RemoveSeqsCommand", "RemoveSeqsCommand");
150 //**********************************************************************************************************************
152 void RemoveSeqsCommand::help(){
154 m->mothurOut("The remove.seqs command reads an .accnos file and at least one of the following file types: fasta, name, group, list, taxonomy or alignreport file.\n");
155 m->mothurOut("It outputs a file containing the sequences NOT in the .accnos file.\n");
156 m->mothurOut("The remove.seqs command parameters are accnos, fasta, name, group, list, taxonomy, alignreport and dups. You must provide accnos and at least one of the file parameters.\n");
157 m->mothurOut("The dups parameter allows you to remove the entire line from a name file if you remove any name from the line. default=false. \n");
158 m->mothurOut("The remove.seqs command should be in the following format: remove.seqs(accnos=yourAccnos, fasta=yourFasta).\n");
159 m->mothurOut("Example remove.seqs(accnos=amazon.accnos, fasta=amazon.fasta).\n");
160 m->mothurOut("Note: No spaces between parameter labels (i.e. fasta), '=' and parameters (i.e.yourFasta).\n\n");
162 catch(exception& e) {
163 m->errorOut(e, "RemoveSeqsCommand", "help");
168 //**********************************************************************************************************************
170 int RemoveSeqsCommand::execute(){
173 if (abort == true) { return 0; }
175 //get names you want to keep
178 if (m->control_pressed) { return 0; }
180 //read through the correct file and output lines you want to keep
181 if (namefile != "") { readName(); }
182 if (fastafile != "") { readFasta(); }
183 if (groupfile != "") { readGroup(); }
184 if (alignfile != "") { readAlign(); }
185 if (listfile != "") { readList(); }
186 if (taxfile != "") { readTax(); }
188 if (m->control_pressed) { for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } return 0; }
190 if (outputNames.size() != 0) {
191 m->mothurOutEndLine();
192 m->mothurOut("Output File Names: "); m->mothurOutEndLine();
193 for (int i = 0; i < outputNames.size(); i++) { m->mothurOut(outputNames[i]); m->mothurOutEndLine(); }
194 m->mothurOutEndLine();
200 catch(exception& e) {
201 m->errorOut(e, "RemoveSeqsCommand", "execute");
206 //**********************************************************************************************************************
207 int RemoveSeqsCommand::readFasta(){
209 if (outputDir == "") { outputDir += hasPath(fastafile); }
210 string outputFileName = outputDir + getRootName(getSimpleName(fastafile)) + "pick" + getExtension(fastafile);
212 openOutputFile(outputFileName, out);
215 openInputFile(fastafile, in);
218 bool wroteSomething = false;
221 if (m->control_pressed) { in.close(); out.close(); remove(outputFileName.c_str()); return 0; }
223 Sequence currSeq(in);
224 name = currSeq.getName();
227 //if this name is in the accnos file
228 if (names.count(name) == 0) {
229 wroteSomething = true;
231 currSeq.printSequence(out);
239 if (wroteSomething == false) { m->mothurOut("Your file contains only sequences from the .accnos file."); m->mothurOutEndLine(); }
240 outputNames.push_back(outputFileName);
245 catch(exception& e) {
246 m->errorOut(e, "RemoveSeqsCommand", "readFasta");
250 //**********************************************************************************************************************
251 int RemoveSeqsCommand::readList(){
253 if (outputDir == "") { outputDir += hasPath(listfile); }
254 string outputFileName = outputDir + getRootName(getSimpleName(listfile)) + "pick" + getExtension(listfile);
256 openOutputFile(outputFileName, out);
259 openInputFile(listfile, in);
261 bool wroteSomething = false;
264 //read in list vector
267 //make a new list vector
269 newList.setLabel(list.getLabel());
272 for (int i = 0; i < list.getNumBins(); i++) {
273 if (m->control_pressed) { in.close(); out.close(); remove(outputFileName.c_str()); return 0; }
275 //parse out names that are in accnos file
276 string binnames = list.get(i);
278 string newNames = "";
279 while (binnames.find_first_of(',') != -1) {
280 string name = binnames.substr(0,binnames.find_first_of(','));
281 binnames = binnames.substr(binnames.find_first_of(',')+1, binnames.length());
283 //if that name is in the .accnos file, add it
284 if (names.count(name) == 0) { newNames += name + ","; }
288 if (names.count(binnames) == 0) { newNames += binnames + ","; }
290 //if there are names in this bin add to new list
291 if (newNames != "") {
292 newNames = newNames.substr(0, newNames.length()-1); //rip off extra comma
293 newList.push_back(newNames);
297 //print new listvector
298 if (newList.getNumBins() != 0) {
299 wroteSomething = true;
308 if (wroteSomething == false) { m->mothurOut("Your file contains only sequences from the .accnos file."); m->mothurOutEndLine(); }
309 outputNames.push_back(outputFileName);
314 catch(exception& e) {
315 m->errorOut(e, "RemoveSeqsCommand", "readList");
319 //**********************************************************************************************************************
320 int RemoveSeqsCommand::readName(){
322 if (outputDir == "") { outputDir += hasPath(namefile); }
323 string outputFileName = outputDir + getRootName(getSimpleName(namefile)) + "pick" + getExtension(namefile);
326 openOutputFile(outputFileName, out);
329 openInputFile(namefile, in);
330 string name, firstCol, secondCol;
332 bool wroteSomething = false;
335 if (m->control_pressed) { in.close(); out.close(); remove(outputFileName.c_str()); return 0; }
340 vector<string> parsedNames;
341 //parse second column saving each name
342 while (secondCol.find_first_of(',') != -1) {
343 name = secondCol.substr(0,secondCol.find_first_of(','));
344 secondCol = secondCol.substr(secondCol.find_first_of(',')+1, secondCol.length());
345 parsedNames.push_back(name);
349 //get name after last ,
350 parsedNames.push_back(secondCol);
352 vector<string> validSecond; validSecond.clear();
353 for (int i = 0; i < parsedNames.size(); i++) {
354 if (names.count(parsedNames[i]) == 0) {
355 validSecond.push_back(parsedNames[i]);
359 if ((dups) && (validSecond.size() != parsedNames.size())) { //if dups is true and we want to get rid of anyone, get rid of everyone
360 for (int i = 0; i < parsedNames.size(); i++) { names.insert(parsedNames[i]); }
362 //if the name in the first column is in the set then print it and any other names in second column also in set
363 if (names.count(firstCol) == 0) {
365 wroteSomething = true;
367 out << firstCol << '\t';
369 //you know you have at least one valid second since first column is valid
370 for (int i = 0; i < validSecond.size()-1; i++) { out << validSecond[i] << ','; }
371 out << validSecond[validSecond.size()-1] << endl;
373 //make first name in set you come to first column and then add the remaining names to second column
376 //you want part of this row
377 if (validSecond.size() != 0) {
379 wroteSomething = true;
381 out << validSecond[0] << '\t';
383 //you know you have at least one valid second since first column is valid
384 for (int i = 0; i < validSecond.size()-1; i++) { out << validSecond[i] << ','; }
385 out << validSecond[validSecond.size()-1] << endl;
394 if (wroteSomething == false) { m->mothurOut("Your file contains only sequences from the .accnos file."); m->mothurOutEndLine(); }
395 outputNames.push_back(outputFileName);
399 catch(exception& e) {
400 m->errorOut(e, "RemoveSeqsCommand", "readName");
405 //**********************************************************************************************************************
406 int RemoveSeqsCommand::readGroup(){
408 if (outputDir == "") { outputDir += hasPath(groupfile); }
409 string outputFileName = outputDir + getRootName(getSimpleName(groupfile)) + "pick" + getExtension(groupfile);
411 openOutputFile(outputFileName, out);
414 openInputFile(groupfile, in);
417 bool wroteSomething = false;
420 if (m->control_pressed) { in.close(); out.close(); remove(outputFileName.c_str()); return 0; }
422 in >> name; //read from first column
423 in >> group; //read from second column
425 //if this name is in the accnos file
426 if (names.count(name) == 0) {
427 wroteSomething = true;
428 out << name << '\t' << group << endl;
436 if (wroteSomething == false) { m->mothurOut("Your file contains only sequences from the .accnos file."); m->mothurOutEndLine(); }
437 outputNames.push_back(outputFileName);
441 catch(exception& e) {
442 m->errorOut(e, "RemoveSeqsCommand", "readGroup");
446 //**********************************************************************************************************************
447 int RemoveSeqsCommand::readTax(){
449 if (outputDir == "") { outputDir += hasPath(taxfile); }
450 string outputFileName = outputDir + getRootName(getSimpleName(taxfile)) + "pick" + getExtension(taxfile);
452 openOutputFile(outputFileName, out);
455 openInputFile(taxfile, in);
458 bool wroteSomething = false;
461 if (m->control_pressed) { in.close(); out.close(); remove(outputFileName.c_str()); return 0; }
463 in >> name; //read from first column
464 in >> tax; //read from second column
466 //if this name is in the accnos file
467 if (names.count(name) == 0) {
468 wroteSomething = true;
469 out << name << '\t' << tax << endl;
477 if (wroteSomething == false) { m->mothurOut("Your file contains only sequences from the .accnos file."); m->mothurOutEndLine(); }
478 outputNames.push_back(outputFileName);
482 catch(exception& e) {
483 m->errorOut(e, "RemoveSeqsCommand", "readTax");
487 //**********************************************************************************************************************
488 //alignreport file has a column header line then all other lines contain 16 columns. we just want the first column since that contains the name
489 int RemoveSeqsCommand::readAlign(){
491 if (outputDir == "") { outputDir += hasPath(alignfile); }
492 string outputFileName = outputDir + getRootName(getSimpleName(alignfile)) + "pick.align.report";
494 openOutputFile(outputFileName, out);
497 openInputFile(alignfile, in);
500 bool wroteSomething = false;
502 //read column headers
503 for (int i = 0; i < 16; i++) {
504 if (!in.eof()) { in >> junk; out << junk << '\t'; }
510 if (m->control_pressed) { in.close(); out.close(); remove(outputFileName.c_str()); return 0; }
512 in >> name; //read from first column
514 //if this name is in the accnos file
515 if (names.count(name) == 0) {
516 wroteSomething = true;
521 for (int i = 0; i < 15; i++) {
522 if (!in.eof()) { in >> junk; out << junk << '\t'; }
527 }else {//still read just don't do anything with it
530 for (int i = 0; i < 15; i++) {
531 if (!in.eof()) { in >> junk; }
541 if (wroteSomething == false) { m->mothurOut("Your file contains only sequences from the .accnos file."); m->mothurOutEndLine(); }
542 outputNames.push_back(outputFileName);
547 catch(exception& e) {
548 m->errorOut(e, "RemoveSeqsCommand", "readAlign");
552 //**********************************************************************************************************************
553 void RemoveSeqsCommand::readAccnos(){
557 openInputFile(accnosfile, in);
570 catch(exception& e) {
571 m->errorOut(e, "RemoveSeqsCommand", "readAccnos");
576 //**********************************************************************************************************************