5 * Created by westcott on 10/13/09.
6 * Copyright 2009 Schloss Lab. All rights reserved.
10 #include "hclustercommand.h"
12 //**********************************************************************************************************************
13 //This function checks to make sure the cluster command has no errors and then clusters based on the method chosen.
14 HClusterCommand::HClusterCommand(string option){
16 globaldata = GlobalData::getInstance();
19 //allow user to run help
20 if(option == "help") { help(); abort = true; }
23 //valid paramters for this command
24 string Array[] = {"cutoff","precision","method","phylip","column","name","sorted","showabund","timing"};
25 vector<string> myArray (Array, Array+(sizeof(Array)/sizeof(string)));
27 OptionParser parser(option);
28 map<string,string> parameters = parser.getParameters();
30 ValidParameters validParameter;
32 //check to make sure all parameters are valid for command
33 for (map<string,string>::iterator it = parameters.begin(); it != parameters.end(); it++) {
34 if (validParameter.isValidParameter(it->first, myArray, it->second) != true) {
39 globaldata->newRead();
41 //check for required parameters
42 phylipfile = validParameter.validFile(parameters, "phylip", true);
43 if (phylipfile == "not open") { abort = true; }
44 else if (phylipfile == "not found") { phylipfile = ""; }
45 else { distfile = phylipfile; format = "phylip"; }
47 columnfile = validParameter.validFile(parameters, "column", true);
48 if (columnfile == "not open") { abort = true; }
49 else if (columnfile == "not found") { columnfile = ""; }
50 else { distfile = columnfile; format = "column"; }
52 namefile = validParameter.validFile(parameters, "name", true);
53 if (namefile == "not open") { abort = true; }
54 else if (namefile == "not found") { namefile = ""; }
56 if ((phylipfile == "") && (columnfile == "")) { mothurOut("When executing a hcluster command you must enter a phylip or a column."); mothurOutEndLine(); abort = true; }
57 else if ((phylipfile != "") && (columnfile != "")) { mothurOut("When executing a hcluster command you must enter ONLY ONE of the following: phylip or column."); mothurOutEndLine(); abort = true; }
59 if (columnfile != "") {
60 if (namefile == "") { cout << "You need to provide a namefile if you are going to use the column format." << endl; abort = true; }
63 //check for optional parameter and set defaults
64 // ...at some point should added some additional type checking...
65 //get user cutoff and precision or use defaults
67 temp = validParameter.validFile(parameters, "precision", false);
68 if (temp == "not found") { temp = "100"; }
69 //saves precision legnth for formatting below
70 length = temp.length();
71 convert(temp, precision);
73 temp = validParameter.validFile(parameters, "cutoff", false);
74 if (temp == "not found") { temp = "10"; }
75 convert(temp, cutoff);
76 cutoff += (5 / (precision * 10.0));
78 method = validParameter.validFile(parameters, "method", false);
79 if (method == "not found") { method = "furthest"; }
81 if ((method == "furthest") || (method == "nearest") || (method == "average")) { }
82 else { mothurOut("Not a valid clustering method. Valid clustering algorithms are furthest, nearest or average."); mothurOutEndLine(); abort = true; }
84 showabund = validParameter.validFile(parameters, "showabund", false);
85 if (showabund == "not found") { showabund = "T"; }
87 sort = validParameter.validFile(parameters, "sorted", false);
88 if (sort == "not found") { sort = "F"; }
89 sorted = isTrue(sort);
91 timing = validParameter.validFile(parameters, "timing", false);
92 if (timing == "not found") { timing = "F"; }
97 fileroot = getRootName(distfile);
99 if (method == "furthest") { tag = "fn"; }
100 else if (method == "nearest") { tag = "nn"; }
103 openOutputFile(fileroot+ tag + ".sabund", sabundFile);
104 openOutputFile(fileroot+ tag + ".rabund", rabundFile);
105 openOutputFile(fileroot+ tag + ".list", listFile);
109 catch(exception& e) {
110 errorOut(e, "HClusterCommand", "HClusterCommand");
115 //**********************************************************************************************************************
117 void HClusterCommand::help(){
119 mothurOut("The hcluster command parameter options are cutoff, precision, method, phylip, column, name, showabund, timing and sorted. Phylip or column and name are required.\n");
120 mothurOut("The phylip and column parameter allow you to enter your distance file, and sorted indicates whether your column distance file is already sorted. \n");
121 mothurOut("The name parameter allows you to enter your name file and is required if your distance file is in column format. \n");
122 mothurOut("The hcluster command should be in the following format: \n");
123 mothurOut("hcluster(column=youDistanceFile, name=yourNameFile, method=yourMethod, cutoff=yourCutoff, precision=yourPrecision) \n");
124 mothurOut("The acceptable hcluster methods are furthest and nearest, but we hope to add average in the future.\n\n");
126 catch(exception& e) {
127 errorOut(e, "HClusterCommand", "help");
132 //**********************************************************************************************************************
134 HClusterCommand::~HClusterCommand(){}
136 //**********************************************************************************************************************
138 int HClusterCommand::execute(){
141 if (abort == true) { return 0; }
144 globaldata->nameMap = new NameAssignment(namefile);
145 globaldata->nameMap->readMap();
147 globaldata->nameMap = NULL;
150 time_t estart = time(NULL);
153 read = new ReadCluster(distfile, cutoff);
154 read->setFormat(format);
155 read->read(globaldata->nameMap);
156 distfile = read->getOutputFile();
158 list = read->getListVector();
161 list = new ListVector(globaldata->nameMap->getListVector());
164 mothurOut("It took " + toString(time(NULL) - estart) + " seconds to sort. "); mothurOutEndLine();
167 //list vector made by read contains all sequence names
169 rabund = new RAbundVector(list->getRAbundVector());
171 mothurOut("Error: no list vector!"); mothurOutEndLine(); return 0;
174 float previousDist = 0.00000;
175 float rndPreviousDist = 0.00000;
182 cluster = new HCluster(rabund, list, method, distfile, globaldata->nameMap, cutoff);
183 vector<seqDist> seqs; seqs.resize(1); // to start loop
185 while (seqs.size() != 0){
187 seqs = cluster->getSeqs();
189 for (int i = 0; i < seqs.size(); i++) { //-1 means skip me
191 if (seqs[i].seq1 != seqs[i].seq2) {
192 cluster->update(seqs[i].seq1, seqs[i].seq2, seqs[i].dist);
194 float rndDist = roundDist(seqs[i].dist, precision);
196 if((previousDist <= 0.0000) && (seqs[i].dist != previousDist)){
199 else if((rndDist != rndPreviousDist)){
200 printData(toString(rndPreviousDist, length-1));
203 previousDist = seqs[i].dist;
204 rndPreviousDist = rndDist;
211 if(previousDist <= 0.0000){
214 else if(rndPreviousDist<cutoff){
215 printData(toString(rndPreviousDist, length-1));
218 //delete globaldata's copy of the sparsematrix and listvector to free up memory
219 delete globaldata->gListVector; globaldata->gListVector = NULL;
221 //saves .list file so you can do the collect, rarefaction and summary commands without doing a read.list
222 if (globaldata->getFormat() == "phylip") { globaldata->setPhylipFile(""); }
223 else if (globaldata->getFormat() == "column") { globaldata->setColumnFile(""); }
225 globaldata->setListFile(fileroot+ tag + ".list");
226 globaldata->setNameFile("");
227 globaldata->setFormat("list");
234 mothurOut("It took " + toString(time(NULL) - estart) + " seconds to cluster. "); mothurOutEndLine();
238 catch(exception& e) {
239 errorOut(e, "HClusterCommand", "execute");
244 //**********************************************************************************************************************
246 void HClusterCommand::printData(string label){
248 if (isTrue(timing)) {
249 mothurOut("\tTime: " + toString(time(NULL) - start) + "\tsecs for " + toString(oldRAbund.getNumBins())
250 + "\tclusters. Updates: " + toString(loops)); mothurOutEndLine();
256 oldRAbund.setLabel(label);
257 if (isTrue(showabund)) {
258 oldRAbund.getSAbundVector().print(cout);
260 oldRAbund.print(rabundFile);
261 oldRAbund.getSAbundVector().print(sabundFile);
263 oldList.setLabel(label);
264 oldList.print(listFile);
266 catch(exception& e) {
267 errorOut(e, "HClusterCommand", "printData");
273 //**********************************************************************************************************************