5 * Created by Sarah Westcott on 3/30/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "venncommand.h"
14 //#include "jackknife.h"
15 #include "sharedsobscollectsummary.h"
16 #include "sharedchao1.h"
17 #include "sharedace.h"
20 //**********************************************************************************************************************
22 VennCommand::VennCommand(string option){
24 globaldata = GlobalData::getInstance();
29 //allow user to run help
30 if(option == "help") { help(); abort = true; }
33 //valid paramters for this command
34 string AlignArray[] = {"groups","label","calc", "abund","outputdir","inputdir"};
35 vector<string> myArray (AlignArray, AlignArray+(sizeof(AlignArray)/sizeof(string)));
37 OptionParser parser(option);
38 map<string,string> parameters = parser.getParameters();
40 ValidParameters validParameter;
42 //check to make sure all parameters are valid for command
43 for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) {
44 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
47 //make sure the user has already run the read.otu command
48 if ((globaldata->getListFile() == "") && (globaldata->getSharedFile() == "")) {
49 mothurOut("You must read a list, or a list and a group, or a shared before you can use the venn command."); mothurOutEndLine(); abort = true;
52 //if the user changes the output directory command factory will send this info to us in the output parameter
53 outputDir = validParameter.validFile(parameters, "outputdir", false); if (outputDir == "not found"){
55 outputDir += hasPath(globaldata->inputFileName); //if user entered a file with a path then preserve it
58 //check for optional parameter and set defaults
59 // ...at some point should added some additional type checking...
60 label = validParameter.validFile(parameters, "label", false);
61 if (label == "not found") { label = ""; }
63 if(label != "all") { splitAtDash(label, labels); allLines = 0; }
64 else { allLines = 1; }
67 //if the user has not specified any labels use the ones from read.otu
69 allLines = globaldata->allLines;
70 labels = globaldata->labels;
73 groups = validParameter.validFile(parameters, "groups", false);
74 if (groups == "not found") { groups = ""; }
76 splitAtDash(groups, Groups);
77 globaldata->Groups = Groups;
80 format = globaldata->getFormat();
81 calc = validParameter.validFile(parameters, "calc", false);
82 if (calc == "not found") {
83 if(format == "list") { calc = "sobs"; }
84 else { calc = "sharedsobs"; }
87 if (calc == "default") {
88 if(format == "list") { calc = "sobs"; }
89 else { calc = "sharedsobs"; }
92 splitAtDash(calc, Estimators);
95 temp = validParameter.validFile(parameters, "abund", false); if (temp == "not found") { temp = "10"; }
99 validCalculator = new ValidCalculators();
103 if (format == "list") {
104 for (i=0; i<Estimators.size(); i++) {
105 if (validCalculator->isValidCalculator("vennsingle", Estimators[i]) == true) {
106 if (Estimators[i] == "sobs") {
107 vennCalculators.push_back(new Sobs());
108 }else if (Estimators[i] == "chao") {
109 vennCalculators.push_back(new Chao1());
110 }else if (Estimators[i] == "ace") {
113 vennCalculators.push_back(new Ace(abund));
118 for (i=0; i<Estimators.size(); i++) {
119 if (validCalculator->isValidCalculator("vennshared", Estimators[i]) == true) {
120 if (Estimators[i] == "sharedsobs") {
121 vennCalculators.push_back(new SharedSobsCS());
122 }else if (Estimators[i] == "sharedchao") {
123 vennCalculators.push_back(new SharedChao1());
124 }else if (Estimators[i] == "sharedace") {
125 vennCalculators.push_back(new SharedAce());
131 venn = new Venn(outputDir);
138 catch(exception& e) {
139 errorOut(e, "VennCommand", "VennCommand");
144 //**********************************************************************************************************************
146 void VennCommand::help(){
148 mothurOut("The venn command can only be executed after a successful read.otu command.\n");
149 mothurOut("The venn command parameters are groups, calc, abund and label. No parameters are required.\n");
150 mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like included in your venn diagram, you may only use a maximum of 4 groups.\n");
151 mothurOut("The group names are separated by dashes. The label allows you to select what distance levels you would like a venn diagram created for, and are also separated by dashes.\n");
152 mothurOut("The venn command should be in the following format: venn(groups=yourGroups, calc=yourCalcs, label=yourLabels, abund=yourAbund).\n");
153 mothurOut("Example venn(groups=A-B-C, calc=sharedsobs-sharedchao, abund=20).\n");
154 mothurOut("The default value for groups is all the groups in your groupfile up to 4, and all labels in your inputfile will be used.\n");
155 mothurOut("The default value for calc is sobs if you have only read a list file or if you have selected only one group, and sharedsobs if you have multiple groups.\n");
156 mothurOut("The default available estimators for calc are sobs, chao and ace if you have only read a list file, and sharedsobs, sharedchao and sharedace if you have read a list and group file or a shared file.\n");
157 mothurOut("The only estmiator available four 4 groups is sharedsobs.\n");
158 mothurOut("The venn command outputs a .svg file for each calculator you specify at each distance you choose.\n");
159 mothurOut("Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups).\n\n");
161 catch(exception& e) {
162 errorOut(e, "VennCommand", "help");
168 //**********************************************************************************************************************
170 VennCommand::~VennCommand(){
171 if (abort == false) {
172 delete input; globaldata->ginput = NULL;
175 globaldata->sabund = NULL;
180 //**********************************************************************************************************************
182 int VennCommand::execute(){
185 if (abort == true) { return 0; }
189 //if the users entered no valid calculators don't execute command
190 if (vennCalculators.size() == 0) { return 0; }
192 if (format == "sharedfile") {
194 read = new ReadOTUFile(globaldata->inputFileName);
195 read->read(&*globaldata);
197 input = globaldata->ginput;
198 lookup = input->getSharedRAbundVectors();
199 lastLabel = lookup[0]->getLabel();
200 }else if (format == "list") {
201 //you are using just a list file and have only one group
202 read = new ReadOTUFile(globaldata->inputFileName);
203 read->read(&*globaldata);
205 sabund = globaldata->sabund;
206 lastLabel = sabund->getLabel();
207 input = globaldata->ginput;
210 //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
211 set<string> processedLabels;
212 set<string> userLabels = labels;
214 if (format != "list") {
216 //as long as you are not at the end of the file or done wih the lines you want
217 while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
219 if(allLines == 1 || labels.count(lookup[0]->getLabel()) == 1){
220 mothurOut(lookup[0]->getLabel()); mothurOutEndLine();
221 processedLabels.insert(lookup[0]->getLabel());
222 userLabels.erase(lookup[0]->getLabel());
224 if (lookup.size() > 4) {
225 mothurOut("Error: Too many groups chosen. You may use up to 4 groups with the venn command. I will use the first four groups in your groupfile."); mothurOutEndLine();
226 for (int i = lookup.size(); i > 4; i--) { lookup.pop_back(); } //no memmory leak because pop_back calls destructor
228 venn->getPic(lookup, vennCalculators);
231 if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
232 string saveLabel = lookup[0]->getLabel();
234 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
235 lookup = input->getSharedRAbundVectors(lastLabel);
237 mothurOut(lookup[0]->getLabel()); mothurOutEndLine();
238 processedLabels.insert(lookup[0]->getLabel());
239 userLabels.erase(lookup[0]->getLabel());
241 if (lookup.size() > 4) {
242 mothurOut("Error: Too many groups chosen. You may use up to 4 groups with the venn command. I will use the first four groups in your groupfile."); mothurOutEndLine();
243 for (int i = lookup.size(); i > 4; i--) { lookup.pop_back(); } //no memmory leak because pop_back calls destructor
245 venn->getPic(lookup, vennCalculators);
247 //restore real lastlabel to save below
248 lookup[0]->setLabel(saveLabel);
252 lastLabel = lookup[0]->getLabel();
254 //get next line to process
255 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
256 lookup = input->getSharedRAbundVectors();
259 //output error messages about any remaining user labels
260 set<string>::iterator it;
261 bool needToRun = false;
262 for (it = userLabels.begin(); it != userLabels.end(); it++) {
263 mothurOut("Your file does not include the label " + *it);
264 if (processedLabels.count(lastLabel) != 1) {
265 mothurOut(". I will use " + lastLabel + "."); mothurOutEndLine();
268 mothurOut(". Please refer to " + lastLabel + "."); mothurOutEndLine();
272 //run last label if you need to
273 if (needToRun == true) {
274 for (int i = 0; i < lookup.size(); i++) { if (lookup[i] != NULL) { delete lookup[i]; } }
275 lookup = input->getSharedRAbundVectors(lastLabel);
277 mothurOut(lookup[0]->getLabel()); mothurOutEndLine();
278 processedLabels.insert(lookup[0]->getLabel());
279 userLabels.erase(lookup[0]->getLabel());
281 if (lookup.size() > 4) {
282 mothurOut("Error: Too many groups chosen. You may use up to 4 groups with the venn command. I will use the first four groups in your groupfile."); mothurOutEndLine();
283 for (int i = lookup.size(); i > 4; i--) { lookup.pop_back(); } //no memmory leak because pop_back calls destructor
285 venn->getPic(lookup, vennCalculators);
286 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
290 //reset groups parameter
291 globaldata->Groups.clear();
295 while((sabund != NULL) && ((allLines == 1) || (userLabels.size() != 0))) {
297 if(allLines == 1 || labels.count(sabund->getLabel()) == 1){
299 mothurOut(sabund->getLabel()); mothurOutEndLine();
300 venn->getPic(sabund, vennCalculators);
302 processedLabels.insert(sabund->getLabel());
303 userLabels.erase(sabund->getLabel());
306 if ((anyLabelsToProcess(sabund->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
307 string saveLabel = sabund->getLabel();
310 sabund = input->getSAbundVector(lastLabel);
312 mothurOut(sabund->getLabel()); mothurOutEndLine();
313 venn->getPic(sabund, vennCalculators);
315 processedLabels.insert(sabund->getLabel());
316 userLabels.erase(sabund->getLabel());
318 //restore real lastlabel to save below
319 sabund->setLabel(saveLabel);
322 lastLabel = sabund->getLabel();
325 sabund = input->getSAbundVector();
328 //output error messages about any remaining user labels
329 set<string>::iterator it;
330 bool needToRun = false;
331 for (it = userLabels.begin(); it != userLabels.end(); it++) {
332 mothurOut("Your file does not include the label " + *it);
333 if (processedLabels.count(lastLabel) != 1) {
334 mothurOut(". I will use " + lastLabel + "."); mothurOutEndLine();
337 mothurOut(". Please refer to " + lastLabel + "."); mothurOutEndLine();
341 //run last label if you need to
342 if (needToRun == true) {
343 if (sabund != NULL) { delete sabund; }
344 sabund = input->getSAbundVector(lastLabel);
346 mothurOut(sabund->getLabel()); mothurOutEndLine();
347 venn->getPic(sabund, vennCalculators);
354 for (int i = 0; i < vennCalculators.size(); i++) { delete vennCalculators[i]; }
357 catch(exception& e) {
358 errorOut(e, "VennCommand", "execute");
363 //**********************************************************************************************************************