2 * rarefactsharedcommand.cpp
5 * Created by Sarah Westcott on 1/6/09.
6 * Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
10 #include "rarefactsharedcommand.h"
11 #include "sharedsobs.h"
12 #include "sharednseqs.h"
14 //**********************************************************************************************************************
16 RareFactSharedCommand::RareFactSharedCommand(string option){
18 globaldata = GlobalData::getInstance();
27 //allow user to run help
28 if(option == "help") { validCalculator = new ValidCalculators(); help(); abort = true; }
31 //valid paramters for this command
32 string Array[] = {"iters","line","label","calc","groups"};
33 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
35 OptionParser parser(option);
36 map<string,string> parameters = parser.getParameters();
38 ValidParameters validParameter;
40 //check to make sure all parameters are valid for command
41 for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) {
42 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) { abort = true; }
45 //make sure the user has already run the read.otu command
46 if (globaldata->getSharedFile() == "") {
47 if (globaldata->getListFile() == "") { mothurOut("You must read a list and a group, or a shared before you can use the collect.shared command."); mothurOutEndLine(); abort = true; }
48 else if (globaldata->getGroupFile() == "") { mothurOut("You must read a list and a group, or a shared before you can use the collect.shared command."); mothurOutEndLine(); abort = true; }
52 //check for optional parameter and set defaults
53 // ...at some point should added some additional type checking...
54 line = validParameter.validFile(parameters, "line", false);
55 if (line == "not found") { line = ""; }
57 if(line != "all") { splitAtDash(line, lines); allLines = 0; }
58 else { allLines = 1; }
61 label = validParameter.validFile(parameters, "label", false);
62 if (label == "not found") { label = ""; }
64 if(label != "all") { splitAtDash(label, labels); allLines = 0; }
65 else { allLines = 1; }
68 //make sure user did not use both the line and label parameters
69 if ((line != "") && (label != "")) { mothurOut("You cannot use both the line and label parameters at the same time. "); mothurOutEndLine(); abort = true; }
70 //if the user has not specified any line or labels use the ones from read.otu
71 else if((line == "") && (label == "")) {
72 allLines = globaldata->allLines;
73 labels = globaldata->labels;
74 lines = globaldata->lines;
77 calc = validParameter.validFile(parameters, "calc", false);
78 if (calc == "not found") { calc = "sharedobserved"; }
80 if (calc == "default") { calc = "sharedobserved"; }
82 splitAtDash(calc, Estimators);
84 groups = validParameter.validFile(parameters, "groups", false);
85 if (groups == "not found") { groups = ""; }
87 splitAtDash(groups, Groups);
89 globaldata->Groups = Groups;
92 temp = validParameter.validFile(parameters, "iters", false); if (temp == "not found") { temp = "1000"; }
93 convert(temp, nIters);
97 string fileNameRoot = getRootName(globaldata->inputFileName);
98 // format = globaldata->getFormat();
101 validCalculator = new ValidCalculators();
103 for (int i=0; i<Estimators.size(); i++) {
104 if (validCalculator->isValidCalculator("sharedrarefaction", Estimators[i]) == true) {
105 if (Estimators[i] == "sharedobserved") {
106 rDisplays.push_back(new RareDisplay(new SharedSobs(), new SharedThreeColumnFile(fileNameRoot+"shared.rarefaction", "")));
107 }else if (Estimators[i] == "sharednseqs") {
108 rDisplays.push_back(new RareDisplay(new SharedNSeqs(), new SharedThreeColumnFile(fileNameRoot+"shared.r_nseqs", "")));
117 catch(exception& e) {
118 errorOut(e, "RareFactSharedCommand", "RareFactSharedCommand");
123 //**********************************************************************************************************************
125 void RareFactSharedCommand::help(){
127 mothurOut("The rarefaction.shared command can only be executed after a successful read.otu command.\n");
128 mothurOut("The rarefaction.shared command parameters are label, line, iters, groups and calc. No parameters are required, but you may not use \n");
129 mothurOut("both the line and label parameters at the same time. The rarefaction command should be in the following format: \n");
130 mothurOut("rarefaction.shared(label=yourLabel, line=yourLines, iters=yourIters, calc=yourEstimators, groups=yourGroups).\n");
131 mothurOut("Example rarefaction.shared(label=unique-.01-.03, line=0-5-10, iters=10000, groups=B-C, calc=sharedobserved).\n");
132 mothurOut("The default values for iters is 1000, freq is 100, and calc is sharedobserved which calculates the shared rarefaction curve for the observed richness.\n");
133 mothurOut("The default value for groups is all the groups in your groupfile.\n");
134 validCalculator->printCalc("sharedrarefaction", cout);
135 mothurOut("The label and line parameters are used to analyze specific lines in your input.\n");
136 mothurOut("The groups parameter allows you to specify which of the groups in your groupfile you would like analyzed. You must enter at least 2 valid groups.\n");
137 mothurOut("Note: No spaces between parameter labels (i.e. freq), '=' and parameters (i.e.yourFreq).\n\n");
139 catch(exception& e) {
140 errorOut(e, "RareFactSharedCommand", "help");
145 //**********************************************************************************************************************
147 RareFactSharedCommand::~RareFactSharedCommand(){
148 if (abort == false) {
149 delete input; globaldata->ginput = NULL;
151 delete validCalculator;
155 //**********************************************************************************************************************
157 int RareFactSharedCommand::execute(){
160 if (abort == true) { return 0; }
164 //if the users entered no valid calculators don't execute command
165 if (rDisplays.size() == 0) { return 0; }
167 read = new ReadOTUFile(globaldata->inputFileName);
168 read->read(&*globaldata);
170 input = globaldata->ginput;
171 lookup = input->getSharedRAbundVectors();
172 string lastLabel = lookup[0]->getLabel();
174 if (lookup.size() < 2) {
175 mothurOut("I cannot run the command without at least 2 valid groups.");
176 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
180 //if the users enters label "0.06" and there is no "0.06" in their file use the next lowest label.
181 set<string> processedLabels;
182 set<string> userLabels = labels;
183 set<int> userLines = lines;
185 //as long as you are not at the end of the file or done wih the lines you want
186 while((lookup[0] != NULL) && ((allLines == 1) || (userLabels.size() != 0) || (userLines.size() != 0))) {
188 if(allLines == 1 || lines.count(count) == 1 || labels.count(lookup[0]->getLabel()) == 1){
190 rCurve = new Rarefact(lookup, rDisplays);
191 rCurve->getSharedCurve(freq, nIters);
194 mothurOut(lookup[0]->getLabel() + "\t" + toString(count)); mothurOutEndLine();
195 processedLabels.insert(lookup[0]->getLabel());
196 userLabels.erase(lookup[0]->getLabel());
197 userLines.erase(count);
200 if ((anyLabelsToProcess(lookup[0]->getLabel(), userLabels, "") == true) && (processedLabels.count(lastLabel) != 1)) {
201 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
202 lookup = input->getSharedRAbundVectors(lastLabel);
204 mothurOut(lookup[0]->getLabel() + "\t" + toString(count)); mothurOutEndLine();
205 rCurve = new Rarefact(lookup, rDisplays);
206 rCurve->getSharedCurve(freq, nIters);
209 processedLabels.insert(lookup[0]->getLabel());
210 userLabels.erase(lookup[0]->getLabel());
214 lastLabel = lookup[0]->getLabel();
216 //get next line to process
217 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
218 lookup = input->getSharedRAbundVectors();
222 //output error messages about any remaining user labels
223 set<string>::iterator it;
224 bool needToRun = false;
225 for (it = userLabels.begin(); it != userLabels.end(); it++) {
226 mothurOut("Your file does not include the label " + *it);
227 if (processedLabels.count(lastLabel) != 1) {
228 mothurOut(". I will use " + lastLabel + "."); mothurOutEndLine();
231 mothurOut(". Please refer to " + lastLabel + "."); mothurOutEndLine();
235 //run last line if you need to
236 if (needToRun == true) {
237 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
238 lookup = input->getSharedRAbundVectors(lastLabel);
240 mothurOut(lookup[0]->getLabel() + "\t" + toString(count)); mothurOutEndLine();
241 rCurve = new Rarefact(lookup, rDisplays);
242 rCurve->getSharedCurve(freq, nIters);
244 for (int i = 0; i < lookup.size(); i++) { delete lookup[i]; }
247 for(int i=0;i<rDisplays.size();i++){ delete rDisplays[i]; }
249 //reset groups parameter
250 globaldata->Groups.clear();
254 catch(exception& e) {
255 errorOut(e, "RareFactSharedCommand", "execute");
261 //**********************************************************************************************************************