* Mothur
*
* Created by Sarah Westcott on 6/2/09.
- * Copyright 2009 __MyCompanyName__. All rights reserved.
+ * Copyright 2009 Schloss Lab Umass Amherst. All rights reserved.
*
*/
#include "getrabundcommand.h"
//**********************************************************************************************************************
+vector<string> GetRAbundCommand::setParameters(){
+ try {
+ CommandParameter plist("list", "InputTypes", "", "", "LRSS", "LRSS", "none","rabund",false,false, true); parameters.push_back(plist);
+ CommandParameter pcount("count", "InputTypes", "", "", "none", "none", "none","",false,false, false); parameters.push_back(pcount);
+ CommandParameter psabund("sabund", "InputTypes", "", "", "LRSS", "LRSS", "none","rabund",false,false, true); parameters.push_back(psabund);
+ CommandParameter psorted("sorted", "Boolean", "", "T", "", "", "","",false,false); parameters.push_back(psorted);
+ 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, "GetRAbundCommand", "setParameters");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+string GetRAbundCommand::getHelpString(){
+ try {
+ string helpString = "";
+ helpString += "The get.rabund command parameters are list, sabund, count, label and sorted. list or sabund parameters are required, unless you have valid current files.\n";
+ helpString += "The count parameter allows you to provide a count file associated with your list file. If you clustered with a countfile the list file only contains the unique sequences and you will want to add the redundant counts into the rabund file, providing the count file allows you to do so.\n";
+ helpString += "The label parameter allows you to select what distance levels you would like included in your .rabund file, and are separated by dashes.\n";
+ helpString += "The sorted parameters allows you to print the rabund results sorted by abundance or not. The default is sorted.\n";
+ helpString += "The get.rabund command should be in the following format: get.rabund(label=yourLabels, sorted=yourSorted).\n";
+ helpString += "Example get.rabund(sorted=F).\n";
+ helpString += "The default value for label is all labels in your inputfile.\n";
+ helpString += "The get.rabund command outputs a .rabund file containing the lines you selected.\n";
+ helpString += "Note: No spaces between parameter labels (i.e. label), '=' and parameters (i.e.yourLabels).\n";
+ return helpString;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "GetRAbundCommand", "getHelpString");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+string GetRAbundCommand::getOutputPattern(string type) {
+ try {
+ string pattern = "";
+
+ if (type == "rabund") { pattern = "[filename],rabund"; }
+ else { m->mothurOut("[ERROR]: No definition for type " + type + " output pattern.\n"); m->control_pressed = true; }
+
+ return pattern;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "GetRAbundCommand", "getOutputPattern");
+ exit(1);
+ }
+}
-GetRAbundCommand::GetRAbundCommand(string option){
+//**********************************************************************************************************************
+GetRAbundCommand::GetRAbundCommand(){
+ try {
+ abort = true; calledHelp = true;
+ setParameters();
+ vector<string> tempOutNames;
+ outputTypes["rabund"] = tempOutNames;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "GetRAbundCommand", "GetRAbundCommand");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+GetRAbundCommand::GetRAbundCommand(string option) {
try {
- globaldata = GlobalData::getInstance();
- abort = false;
+ abort = false; calledHelp = false;
allLines = 1;
- lines.clear();
- labels.clear();
//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[] = {"line","label"};
- vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+ vector<string> myArray = setParameters();
OptionParser parser(option);
map<string,string> parameters = parser.getParameters();
+ map<string,string>::iterator it;
ValidParameters validParameter;
//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; }
}
- //make sure the user has already run the read.otu command
- if (globaldata->getListFile() == "") { cout << "You must read a listfile before you can use the get.rabund command." << endl; abort = true; }
+ //initialize outputTypes
+ vector<string> tempOutNames;
+ outputTypes["rabund"] = tempOutNames;
+
+ //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("list");
+ //user has given a template file
+ if(it != parameters.end()){
+ path = m->hasPath(it->second);
+ //if the user has not given a path then, add inputdir. else leave path alone.
+ if (path == "") { parameters["list"] = inputDir + it->second; }
+ }
+
+ it = parameters.find("sabund");
+ //user has given a template file
+ if(it != parameters.end()){
+ path = m->hasPath(it->second);
+ //if the user has not given a path then, add inputdir. else leave path alone.
+ if (path == "") { parameters["sabund"] = inputDir + it->second; }
+ }
+
+ it = parameters.find("count");
+ //user has given a template file
+ if(it != parameters.end()){
+ path = m->hasPath(it->second);
+ //if the user has not given a path then, add inputdir. else leave path alone.
+ if (path == "") { parameters["count"] = inputDir + it->second; }
+ }
+ }
+
+
+ //check for required parameters
+ listfile = validParameter.validFile(parameters, "list", true);
+ if (listfile == "not open") { listfile = ""; abort = true; }
+ else if (listfile == "not found") { listfile = ""; }
+ else { format = "list"; inputfile = listfile; m->setListFile(listfile); }
+
+ sabundfile = validParameter.validFile(parameters, "sabund", true);
+ if (sabundfile == "not open") { sabundfile = ""; abort = true; }
+ else if (sabundfile == "not found") { sabundfile = ""; }
+ else { format = "sabund"; inputfile = sabundfile; m->setSabundFile(sabundfile); }
+
+ countfile = validParameter.validFile(parameters, "count", true);
+ if (countfile == "not open") { countfile = ""; abort = true; }
+ else if (countfile == "not found") { countfile = ""; }
+ else { m->setCountTableFile(countfile); }
+
//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; }
- }
+ string temp;
+ temp = validParameter.validFile(parameters, "sorted", false); if (temp == "not found") { temp = "T"; }
+ sorted = m->isTrue(temp);
label = validParameter.validFile(parameters, "label", false);
if (label == "not found") { label = ""; }
else {
- if(label != "all") { splitAtDash(label, labels); allLines = 0; }
+ if(label != "all") { m->splitAtDash(label, labels); allLines = 0; }
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 == "")) {
- allLines = globaldata->allLines;
- labels = globaldata->labels;
- lines = globaldata->lines;
- }
-
- if (abort == false) {
- filename = getRootName(globaldata->inputFileName) + "rabund";
- openOutputFile(filename, out);
+ if ((listfile == "") && (sabundfile == "")) {
+ //is there are current file available for any of these?
+ //give priority to shared, then list, then rabund, then sabund
+ //if there is a current shared file, use it
+ listfile = m->getListFile();
+ if (listfile != "") { inputfile = listfile; format = "list"; m->mothurOut("Using " + listfile + " as input file for the list parameter."); m->mothurOutEndLine(); }
+ else {
+ sabundfile = m->getSabundFile();
+ if (sabundfile != "") { inputfile = sabundfile; format = "sabund"; m->mothurOut("Using " + sabundfile + " as input file for the sabund parameter."); m->mothurOutEndLine(); }
+ else {
+ m->mothurOut("No valid current files. You must provide a list or sabund file."); m->mothurOutEndLine();
+ abort = true;
+ }
+ }
}
+
+ if ((countfile != "") && (listfile == "")) { m->mothurOut("[ERROR]: You can only use the count file with a list file, aborting.\n"); 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 = m->hasPath(inputfile); }
+
}
-
- }
- catch(exception& e) {
- cout << "Standard Error: " << e.what() << " has occurred in the GetRAbundCommand class Function GetRAbundCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
- exit(1);
- }
- catch(...) {
- cout << "An unknown error has occurred in the GetRAbundCommand class function GetRAbundCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
- exit(1);
- }
-}
-//**********************************************************************************************************************
-void GetRAbundCommand::help(){
- try {
- cout << "The get.rabund command can only be executed after a successful read.otu of a listfile." << "\n";
- cout << "The get.rabund command parameters are line and label. No parameters are 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 included in your .rabund file, and are separated by dashes." << "\n";
- cout << "The get.rabund command should be in the following format: get.rabund(line=yourLines, label=yourLabels)." << "\n";
- cout << "Example get.rabund(line=1-3-5)." << "\n";
- cout << "The default value for line and label are all lines in your inputfile." << "\n";
- cout << "The get.rabund command outputs a .rabund file containing the lines you selected." << "\n";
- cout << "Note: No spaces between parameter labels (i.e. line), '=' and parameters (i.e.yourLines)." << "\n" << "\n";
}
catch(exception& e) {
- cout << "Standard Error: " << e.what() << " has occurred in the GetRAbundCommand class Function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+ m->errorOut(e, "GetRAbundCommand", "GetRAbundCommand");
exit(1);
- }
- catch(...) {
- cout << "An unknown error has occurred in the GetRAbundCommand class function help. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
- exit(1);
- }
+ }
}
-
-//**********************************************************************************************************************
-
-GetRAbundCommand::~GetRAbundCommand(){
-}
-
//**********************************************************************************************************************
int GetRAbundCommand::execute(){
try {
- if (abort == true) { return 0; }
-
- int count = 1;
+ if (abort == true) { if (calledHelp) { return 0; } return 2; }
- //read first line
- read = new ReadOTUFile(globaldata->inputFileName);
- read->read(&*globaldata);
-
- input = globaldata->ginput;
- list = globaldata->gListVector;
- ListVector* lastList = list;
-
- //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;
-
+ map<string, string> variables;
+ variables["[filename]"] = outputDir + m->getRootName(m->getSimpleName(inputfile));
+ filename = getOutputFileName("rabund", variables);
+ m->openOutputFile(filename, out);
- while((list != NULL) && ((allLines == 1) || (userLabels.size() != 0) || (userLines.size() != 0))) {
-
- if(allLines == 1 || lines.count(count) == 1 || labels.count(list->getLabel()) == 1){
- cout << list->getLabel() << '\t' << count << endl;
- rabund = new RAbundVector();
- *rabund = (list->getRAbundVector());
- rabund->print(out);
+ if (countfile != "") {
+ processList(out);
+ }else {
+ InputData input(inputfile, format);
+ RAbundVector* rabund = input.getRAbundVector();
+ string lastLabel = rabund->getLabel();
+
+ //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;
+
+ if (m->control_pressed) { outputTypes.clear(); out.close(); m->mothurRemove(filename); delete rabund; return 0; }
+
+ while((rabund != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
+
+ if(allLines == 1 || labels.count(rabund->getLabel()) == 1){
+ m->mothurOut(rabund->getLabel()); m->mothurOutEndLine();
+
+ if (m->control_pressed) { outputTypes.clear(); out.close(); m->mothurRemove(filename); delete rabund; return 0; }
+
+ if(sorted) { rabund->print(out); }
+ else { rabund->nonSortedPrint(out); }
+
+ processedLabels.insert(rabund->getLabel());
+ userLabels.erase(rabund->getLabel());
+ }
+
+ if ((m->anyLabelsToProcess(rabund->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+ string saveLabel = rabund->getLabel();
+
delete rabund;
-
- processedLabels.insert(list->getLabel());
- userLabels.erase(list->getLabel());
- userLines.erase(count);
- }
-
- if ((anyLabelsToProcess(list->getLabel(), userLabels, "") == true) && (processedLabels.count(lastList->getLabel()) != 1)) {
- cout << lastList->getLabel() << '\t' << count << endl;
- rabund = new RAbundVector();
- *rabund = (lastList->getRAbundVector());
- rabund->print(out);
- delete rabund;
-
- processedLabels.insert(lastList->getLabel());
- userLabels.erase(lastList->getLabel());
- }
-
- if (count != 1) { delete lastList; }
- lastList = list;
-
- list = input->getListVector();
- count++;
+ rabund = input.getRAbundVector(lastLabel);
+
+ m->mothurOut(rabund->getLabel()); m->mothurOutEndLine();
+
+ if (m->control_pressed) { outputTypes.clear(); out.close(); m->mothurRemove(filename); delete rabund; return 0; }
+
+ if(sorted) { rabund->print(out); }
+ else { rabund->nonSortedPrint(out); }
+
+ processedLabels.insert(rabund->getLabel());
+ userLabels.erase(rabund->getLabel());
+
+ //restore real lastlabel to save below
+ rabund->setLabel(saveLabel);
+ }
+
+ lastLabel = rabund->getLabel();
+
+ delete rabund;
+ rabund = input.getRAbundVector();
+ }
+
+ //output error messages about any remaining user labels
+ set<string>::iterator it;
+ bool needToRun = false;
+ for (it = userLabels.begin(); it != userLabels.end(); it++) {
+ m->mothurOut("Your file does not include the label " + *it);
+ if (processedLabels.count(lastLabel) != 1) {
+ m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
+ needToRun = true;
+ }else {
+ m->mothurOut(". Please refer to " + lastLabel + "."); m->mothurOutEndLine();
+ }
+ }
+
+ //run last label if you need to
+ if (needToRun == true) {
+ if (rabund != NULL) { delete rabund; }
+ rabund = input.getRAbundVector(lastLabel);
+
+ m->mothurOut(rabund->getLabel()); m->mothurOutEndLine();
+
+ if (m->control_pressed) { outputTypes.clear(); out.close(); m->mothurRemove(filename); delete rabund; return 0; }
+
+ if(sorted) { rabund->print(out); }
+ else { rabund->nonSortedPrint(out); }
+
+ delete rabund;
+ }
}
+
+ if (m->control_pressed) { outputTypes.clear(); out.close(); m->mothurRemove(filename); return 0; }
+
+ m->mothurOutEndLine();
+ m->mothurOut("Output File Names: "); m->mothurOutEndLine();
+ m->mothurOut(filename); m->mothurOutEndLine(); outputNames.push_back(filename); outputTypes["rabund"].push_back(filename);
+ m->mothurOutEndLine();
- //output error messages about any remaining user labels
- set<string>::iterator it;
- bool needToRun = false;
- for (it = userLabels.begin(); it != userLabels.end(); it++) {
- cout << "Your file does not include the label "<< *it;
- if (processedLabels.count(lastList->getLabel()) != 1) {
- cout << ". I will use " << lastList->getLabel() << "." << endl;
- needToRun = true;
- }else {
- cout << ". Please refer to " << lastList->getLabel() << "." << endl;
- }
+ out.close();
+
+ //set rabund file as new current rabundfile
+ string current = "";
+ itTypes = outputTypes.find("rabund");
+ if (itTypes != outputTypes.end()) {
+ if ((itTypes->second).size() != 0) { current = (itTypes->second)[0]; m->setRabundFile(current); }
}
- //run last line if you need to
- if (needToRun == true) {
- cout << lastList->getLabel() << '\t' << count << endl;
- rabund = new RAbundVector();
- *rabund = (lastList->getRAbundVector());
- rabund->print(out);
- delete rabund;
- }
- delete lastList;
-
- out.close();
return 0;
}
catch(exception& e) {
- cout << "Standard Error: " << e.what() << " has occurred in the GetRAbundCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+ m->errorOut(e, "GetRAbundCommand", "execute");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+int GetRAbundCommand::processList(ofstream& out){
+ try {
+ CountTable ct;
+ ct.readTable(countfile, false, false);
+
+ InputData input(inputfile, format);
+ ListVector* list = input.getListVector();
+ string lastLabel = list->getLabel();
+
+ //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;
+
+ if (m->control_pressed) { delete list; return 0; }
+
+ while((list != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
+
+ if(allLines == 1 || labels.count(list->getLabel()) == 1){
+ m->mothurOut(list->getLabel()); m->mothurOutEndLine();
+
+ if (m->control_pressed) { delete list; return 0; }
+
+ RAbundVector* rabund = new RAbundVector();
+ createRabund(ct, list, rabund);
+
+ if(sorted) { rabund->print(out); }
+ else { rabund->nonSortedPrint(out); }
+
+ delete rabund;
+ processedLabels.insert(list->getLabel());
+ userLabels.erase(list->getLabel());
+ }
+
+ if ((m->anyLabelsToProcess(list->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+ string saveLabel = list->getLabel();
+
+ delete list;
+ list = input.getListVector(lastLabel);
+
+ m->mothurOut(list->getLabel()); m->mothurOutEndLine();
+
+ if (m->control_pressed) { delete list; return 0; }
+
+ RAbundVector* rabund = new RAbundVector();
+ createRabund(ct, list, rabund);
+
+ if(sorted) { rabund->print(out); }
+ else { rabund->nonSortedPrint(out); }
+
+ delete rabund;
+ 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();
+ }
+
+ //output error messages about any remaining user labels
+ set<string>::iterator it;
+ bool needToRun = false;
+ for (it = userLabels.begin(); it != userLabels.end(); it++) {
+ m->mothurOut("Your file does not include the label " + *it);
+ if (processedLabels.count(lastLabel) != 1) {
+ m->mothurOut(". I will use " + lastLabel + "."); m->mothurOutEndLine();
+ needToRun = true;
+ }else {
+ m->mothurOut(". Please refer to " + lastLabel + "."); m->mothurOutEndLine();
+ }
+ }
+
+ //run last label if you need to
+ if (needToRun == true) {
+ if (list != NULL) { delete list; }
+ list = input.getListVector(lastLabel);
+
+ m->mothurOut(list->getLabel()); m->mothurOutEndLine();
+
+ if (m->control_pressed) { delete list; return 0; }
+
+ RAbundVector* rabund = new RAbundVector();
+ createRabund(ct, list, rabund);
+
+ if(sorted) { rabund->print(out); }
+ else { rabund->nonSortedPrint(out); }
+
+ delete rabund;
+ delete list;
+ }
+
+ return 0;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "GetRAbundCommand", "processList");
exit(1);
}
- catch(...) {
- cout << "An unknown error has occurred in the GetRAbundCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+}
+//**********************************************************************************************************************
+
+int GetRAbundCommand::createRabund(CountTable& ct, ListVector*& list, RAbundVector*& rabund){
+ try {
+
+ rabund->setLabel(list->getLabel());
+ for(int i = 0; i < list->getNumBins(); i++) {
+ if (m->control_pressed) { return 0; }
+ vector<string> binNames;
+ string bin = list->get(i);
+ m->splitAtComma(bin, binNames);
+ int total = 0;
+ for (int j = 0; j < binNames.size(); j++) {
+ total += ct.getNumSeqs(binNames[j]);
+ }
+ rabund->push_back(total);
+ }
+
+ return 0;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "GetRAbundCommand", "createRabund");
exit(1);
- }
+ }
+
}
//**********************************************************************************************************************
projects / mothur.git / blobdiff