#include "sharedmorisitahorn.h"
#include "sharedbraycurtis.h"
-
+//**********************************************************************************************************************
+vector<string> MatrixOutputCommand::getValidParameters(){
+ try {
+ string Array[] = {"label","calc","groups","outputdir","inputdir", "output"};
+ vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+ return myArray;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "MatrixOutputCommand", "getValidParameters");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+MatrixOutputCommand::MatrixOutputCommand(){
+ try {
+ abort = true;
+ //initialize outputTypes
+ vector<string> tempOutNames;
+ outputTypes["phylip"] = tempOutNames;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "MatrixOutputCommand", "MatrixOutputCommand");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+vector<string> MatrixOutputCommand::getRequiredParameters(){
+ try {
+ vector<string> myArray;
+ return myArray;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "MatrixOutputCommand", "getRequiredParameters");
+ exit(1);
+ }
+}
+//**********************************************************************************************************************
+vector<string> MatrixOutputCommand::getRequiredFiles(){
+ try {
+ string Array[] = {"shared"};
+ vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+ return myArray;
+ }
+ catch(exception& e) {
+ m->errorOut(e, "MatrixOutputCommand", "getRequiredFiles");
+ exit(1);
+ }
+}
//**********************************************************************************************************************
-MatrixOutputCommand::MatrixOutputCommand(){
+MatrixOutputCommand::MatrixOutputCommand(string option) {
try {
globaldata = GlobalData::getInstance();
- validCalculator = new ValidCalculators();
+ abort = false;
+ allLines = 1;
+ labels.clear();
+ Groups.clear();
+ Estimators.clear();
+
+ //allow user to run help
+ if(option == "help") { validCalculator = new ValidCalculators(); help(); abort = true; }
+
+ else {
+ //valid paramters for this command
+ string Array[] = {"label","calc","groups","outputdir","inputdir", "output"};
+ vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
+
+ OptionParser parser(option);
+ map<string,string> parameters = parser.getParameters();
+
+ ValidParameters validParameter;
+
+ //check to make sure all parameters are valid for command
+ for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) {
+ if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
+ }
+
+ //initialize outputTypes
+ vector<string> tempOutNames;
+ outputTypes["phylip"] = tempOutNames;
+
+ //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 += m->hasPath(globaldata->inputFileName); //if user entered a file with a path then preserve it
+ }
- int i;
- for (i=0; i<globaldata->Estimators.size(); i++) {
- if (validCalculator->isValidCalculator("matrix", globaldata->Estimators[i]) == true) {
- if (globaldata->Estimators[i] == "jabund") {
- matrixCalculators.push_back(new JAbund());
- }else if (globaldata->Estimators[i] == "sorabund") {
- matrixCalculators.push_back(new SorAbund());
- }else if (globaldata->Estimators[i] == "jclass") {
- matrixCalculators.push_back(new Jclass());
- }else if (globaldata->Estimators[i] == "sorclass") {
- matrixCalculators.push_back(new SorClass());
- }else if (globaldata->Estimators[i] == "jest") {
- matrixCalculators.push_back(new Jest());
- }else if (globaldata->Estimators[i] == "sorest") {
- matrixCalculators.push_back(new SorEst());
- }else if (globaldata->Estimators[i] == "thetayc") {
- matrixCalculators.push_back(new ThetaYC());
- }else if (globaldata->Estimators[i] == "thetan") {
- matrixCalculators.push_back(new ThetaN());
- }else if (globaldata->Estimators[i] == "morisitahorn") {
- matrixCalculators.push_back(new MorHorn());
- }else if (globaldata->Estimators[i] == "braycurtis") {
- matrixCalculators.push_back(new BrayCurtis());
+ //make sure the user has already run the read.otu command
+ if (globaldata->getSharedFile() == "") {
+ if (globaldata->getListFile() == "") { m->mothurOut("You must read a list and a group, or a shared before you can use the dist.shared command."); m->mothurOutEndLine(); abort = true; }
+ else if (globaldata->getGroupFile() == "") { m->mothurOut("You must read a list and a group, or a shared before you can use the dist.shared command."); m->mothurOutEndLine(); abort = true; }
+ }
+
+ //check for optional parameter and set defaults
+ // ...at some point should added some additional type checking...
+ label = validParameter.validFile(parameters, "label", false);
+ if (label == "not found") { label = ""; }
+ else {
+ if(label != "all") { m->splitAtDash(label, labels); allLines = 0; }
+ else { allLines = 1; }
+ }
+
+ output = validParameter.validFile(parameters, "output", false); if(output == "not found"){ output = "lt"; }
+ if ((output != "lt") && (output != "square")) { m->mothurOut(output + " is not a valid output form. Options are lt and square. I will use lt."); m->mothurOutEndLine(); output = "lt"; }
+
+ //if the user has not specified any labels use the ones from read.otu
+ if (label == "") {
+ allLines = globaldata->allLines;
+ labels = globaldata->labels;
+ }
+
+ groups = validParameter.validFile(parameters, "groups", false);
+ if (groups == "not found") { groups = ""; }
+ else {
+ m->splitAtDash(groups, Groups);
+ globaldata->Groups = Groups;
+ }
+
+ calc = validParameter.validFile(parameters, "calc", false);
+ if (calc == "not found") { calc = "jclass-thetayc"; }
+ else {
+ if (calc == "default") { calc = "jclass-thetayc"; }
+ }
+ m->splitAtDash(calc, Estimators);
+
+ if (abort == false) {
+
+ validCalculator = new ValidCalculators();
+
+ int i;
+ for (i=0; i<Estimators.size(); i++) {
+ if (validCalculator->isValidCalculator("matrix", Estimators[i]) == true) {
+ if (Estimators[i] == "jabund") {
+ matrixCalculators.push_back(new JAbund());
+ }else if (Estimators[i] == "sorabund") {
+ matrixCalculators.push_back(new SorAbund());
+ }else if (Estimators[i] == "jclass") {
+ matrixCalculators.push_back(new Jclass());
+ }else if (Estimators[i] == "sorclass") {
+ matrixCalculators.push_back(new SorClass());
+ }else if (Estimators[i] == "jest") {
+ matrixCalculators.push_back(new Jest());
+ }else if (Estimators[i] == "sorest") {
+ matrixCalculators.push_back(new SorEst());
+ }else if (Estimators[i] == "thetayc") {
+ matrixCalculators.push_back(new ThetaYC());
+ }else if (Estimators[i] == "thetan") {
+ matrixCalculators.push_back(new ThetaN());
+ }else if (Estimators[i] == "morisitahorn") {
+ matrixCalculators.push_back(new MorHorn());
+ }else if (Estimators[i] == "braycurtis") {
+ matrixCalculators.push_back(new BrayCurtis());
+ }
+ }
}
+
}
}
- //reset calc for next command
- globaldata->setCalc("");
-
}
catch(exception& e) {
- cout << "Standard Error: " << e.what() << " has occurred in the MatrixOutputCommand class Function MatrixOutputCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+ m->errorOut(e, "MatrixOutputCommand", "MatrixOutputCommand");
exit(1);
}
- catch(...) {
- cout << "An unknown error has occurred in the MatrixOutputCommand class function MatrixOutputCommand. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+}
+
+//**********************************************************************************************************************
+
+void MatrixOutputCommand::help(){
+ try {
+ m->mothurOut("The dist.shared command can only be executed after a successful read.otu command.\n");
+ m->mothurOut("The dist.shared command parameters are groups, calc, output and label. No parameters are required.\n");
+ m->mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like included used.\n");
+ m->mothurOut("The group names are separated by dashes. The label parameter allows you to select what distance levels you would like distance matrices created for, and is also separated by dashes.\n");
+ m->mothurOut("The dist.shared command should be in the following format: dist.shared(groups=yourGroups, calc=yourCalcs, label=yourLabels).\n");
+ m->mothurOut("The output parameter allows you to specify format of your distance matrix. Options are lt, and square. The default is lt.\n");
+ m->mothurOut("Example dist.shared(groups=A-B-C, calc=jabund-sorabund).\n");
+ m->mothurOut("The default value for groups is all the groups in your groupfile.\n");
+ m->mothurOut("The default value for calc is jclass and thetayc.\n");
+ validCalculator->printCalc("matrix", cout);
+ m->mothurOut("The dist.shared command outputs a .dist file for each calculator you specify at each distance you choose.\n");
+ m->mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n");
+ }
+ catch(exception& e) {
+ m->errorOut(e, "MatrixOutputCommand", "help");
exit(1);
- }
+ }
}
+
+
//**********************************************************************************************************************
MatrixOutputCommand::~MatrixOutputCommand(){
- delete input;
- delete read;
+ if (abort == false) {
+ delete input; globaldata->ginput = NULL;
+ delete read;
+ delete validCalculator;
+ }
}
//**********************************************************************************************************************
int MatrixOutputCommand::execute(){
try {
- int count = 1;
- EstOutput data;
- vector<SharedRAbundVector*> subset;
+ if (abort == true) { return 0; }
+
//if the users entered no valid calculators don't execute command
- if (matrixCalculators.size() == 0) { cout << "No valid calculators." << endl; return 0; }
+ if (matrixCalculators.size() == 0) { m->mothurOut("No valid calculators."); m->mothurOutEndLine(); return 0; }
//you have groups
read = new ReadOTUFile(globaldata->inputFileName);
input = globaldata->ginput;
lookup = input->getSharedRAbundVectors();
-
- if (lookup.size() < 2) { cout << "You have not provided enough valid groups. I cannot run the command." << endl; return 0;}
+ string lastLabel = lookup[0]->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 (lookup.size() < 2) { m->mothurOut("You have not provided enough valid groups. I cannot run the command."); m->mothurOutEndLine(); return 0;}
+
+ numGroups = lookup.size();
- numGroups = globaldata->Groups.size();
+ if (m->control_pressed) { delete read; delete input; globaldata->ginput = NULL; for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; } globaldata->Groups.clear(); return 0; }
- while(lookup[0] != NULL){
+ //as long as you are not at the end of the file or done wih the lines you want
+ while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
- if(globaldata->allLines == 1 || globaldata->lines.count(count) == 1 || globaldata->labels.count(lookup[0]->getLabel()) == 1){
+ if (m->control_pressed) { outputTypes.clear(); delete read; delete input; globaldata->ginput = NULL; for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; } for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } globaldata->Groups.clear(); return 0; }
+
+ if(allLines == 1 || labels.count(lookup[0]->getLabel()) == 1){
+ m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
+ process(lookup);
+
+ processedLabels.insert(lookup[0]->getLabel());
+ userLabels.erase(lookup[0]->getLabel());
+ }
+
+ if ((m->anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
+ string saveLabel = lookup[0]->getLabel();
- cout << lookup[0]->getLabel() << '\t' << count << endl;
+ for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
+ lookup = input->getSharedRAbundVectors(lastLabel);
+
+ m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
+ process(lookup);
+
+ processedLabels.insert(lookup[0]->getLabel());
+ userLabels.erase(lookup[0]->getLabel());
+ //restore real lastlabel to save below
+ lookup[0]->setLabel(saveLabel);
+ }
+
+ lastLabel = lookup[0]->getLabel();
+
+ //get next line to process
+ for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
+ lookup = input->getSharedRAbundVectors();
+ }
+
+ if (m->control_pressed) { outputTypes.clear(); delete read; delete input; globaldata->ginput = NULL; for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } globaldata->Groups.clear(); return 0; }
+
+ //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();
+ }
+ }
+
+ if (m->control_pressed) { outputTypes.clear(); delete read; delete input; globaldata->ginput = NULL; for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } globaldata->Groups.clear(); return 0; }
+
+ //run last label if you need to
+ if (needToRun == true) {
+ for (int i = 0; i < lookup.size(); i++) { if (lookup[i] != NULL) { delete lookup[i]; } }
+ lookup = input->getSharedRAbundVectors(lastLabel);
+
+ m->mothurOut(lookup[0]->getLabel()); m->mothurOutEndLine();
+ process(lookup);
+ for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
+ }
+
+ if (m->control_pressed) { outputTypes.clear(); delete read; delete input; globaldata->ginput = NULL; for (int i = 0; i < outputNames.size(); i++) { remove(outputNames[i].c_str()); } globaldata->Groups.clear(); return 0; }
+
+ //reset groups parameter
+ globaldata->Groups.clear();
+
+ 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) {
+ m->errorOut(e, "MatrixOutputCommand", "execute");
+ exit(1);
+ }
+}
+/***********************************************************/
+void MatrixOutputCommand::printSims(ostream& out) {
+ try {
+
+ out.setf(ios::fixed, ios::floatfield); out.setf(ios::showpoint);
+
+ //output num seqs
+ out << simMatrix.size() << endl;
+
+ if (output == "lt") {
+ for (int m = 0; m < simMatrix.size(); m++) {
+ out << lookup[m]->getGroup() << '\t';
+ for (int n = 0; n < m; n++) {
+ out << simMatrix[m][n] << '\t';
+ }
+ out << endl;
+ }
+ }else{
+ for (int m = 0; m < simMatrix.size(); m++) {
+ out << lookup[m]->getGroup() << '\t';
+ for (int n = 0; n < simMatrix[m].size(); n++) {
+ out << simMatrix[m][n] << '\t';
+ }
+ out << endl;
+ }
+ }
+ }
+ catch(exception& e) {
+ m->errorOut(e, "MatrixOutputCommand", "printSims");
+ exit(1);
+ }
+}
+/***********************************************************/
+int MatrixOutputCommand::process(vector<SharedRAbundVector*> thisLookup){
+ try {
+
+ EstOutput data;
+ vector<SharedRAbundVector*> subset;
+
//for each calculator
for(int i = 0 ; i < matrixCalculators.size(); i++) {
//initialize simMatrix
simMatrix.clear();
simMatrix.resize(numGroups);
- for (int m = 0; m < simMatrix.size(); m++) {
+ for (int p = 0; p < simMatrix.size(); p++) {
for (int j = 0; j < simMatrix.size(); j++) {
- simMatrix[m].push_back(0.0);
+ simMatrix[p].push_back(0.0);
}
}
- for (int k = 0; k < lookup.size(); k++) {
- for (int l = k; l < lookup.size(); l++) {
+ for (int k = 0; k < thisLookup.size(); k++) {
+ for (int l = k; l < thisLookup.size(); l++) {
if (k != l) { //we dont need to similiarity of a groups to itself
//get estimated similarity between 2 groups
+ if (m->control_pressed) { return 0; }
+
subset.clear(); //clear out old pair of sharedrabunds
//add new pair of sharedrabunds
- subset.push_back(lookup[k]); subset.push_back(lookup[l]);
+ subset.push_back(thisLookup[k]); subset.push_back(thisLookup[l]);
data = matrixCalculators[i]->getValues(subset); //saves the calculator outputs
//save values in similarity matrix
}
}
- exportFileName = getRootName(globaldata->inputFileName) + matrixCalculators[i]->getName() + "." + lookup[0]->getLabel() + ".dist";
- openOutputFile(exportFileName, out);
+ exportFileName = outputDir + m->getRootName(m->getSimpleName(globaldata->inputFileName)) + matrixCalculators[i]->getName() + "." + thisLookup[0]->getLabel() + "." + output + ".dist";
+ m->openOutputFile(exportFileName, out);
+ outputNames.push_back(exportFileName); outputTypes["phylip"].push_back(exportFileName);
+
printSims(out);
out.close();
}
- }
-
- //prevent memory leak
- for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
-
- //get next line to process
- lookup = input->getSharedRAbundVectors();
- count++;
- }
-
- //reset groups parameter
- globaldata->Groups.clear(); globaldata->setGroups("");
- return 0;
- }
- catch(exception& e) {
- cout << "Standard Error: " << e.what() << " has occurred in the MatrixOutputCommand class Function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
- exit(1);
- }
- catch(...) {
- cout << "An unknown error has occurred in the MatrixOutputCommand class function execute. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
- exit(1);
- }
-}
-/***********************************************************/
-void MatrixOutputCommand::printSims(ostream& out) {
- try {
+ return 0;
- //output column headers
- out << simMatrix.size() << endl;
-
- for (int m = 0; m < simMatrix.size(); m++) {
- out << lookup[m]->getGroup() << '\t';
- for (int n = 0; n < m; n++) {
- out << simMatrix[m][n] << '\t';
- }
- out << endl;
- }
-
}
catch(exception& e) {
- cout << "Standard Error: " << e.what() << " has occurred in the MatrixOutputCommand class Function printSims. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
+ m->errorOut(e, "MatrixOutputCommand", "process");
exit(1);
}
- catch(...) {
- cout << "An unknown error has occurred in the MatrixOutputCommand class function printSims. Please contact Pat Schloss at pschloss@microbio.umass.edu." << "\n";
- exit(1);
- }
}
/***********************************************************/
+
projects / mothur.git / blobdiff