summarysharedcommand.h

   1 #ifndef SUMMARYSHAREDCOMMAND_H
   2 #define SUMMARYSHAREDCOMMAND_H
   3 /*
   4  *  summarysharedcommand.h
   5  *  Dotur
   6  *
   7  *  Created by Sarah Westcott on 1/2/09.
   8  *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
   9  *
  10  */
  11
  12
  13 #include "command.hpp"
  14 #include "sharedrabundvector.h"
  15 #include "inputdata.h"
  16 #include "calculator.h"
  17 #include "validcalculator.h"
  18 #include "sharedsobscollectsummary.h"
  19 #include "sharedchao1.h"
  20 #include "sharedace.h"
  21 #include "sharednseqs.h"
  22 #include "sharedjabund.h"
  23 #include "sharedsorabund.h"
  24 #include "sharedjclass.h"
  25 #include "sharedsorclass.h"
  26 #include "sharedjest.h"
  27 #include "sharedsorest.h"
  28 #include "sharedthetayc.h"
  29 #include "sharedthetan.h"
  30 #include "sharedkstest.h"
  31 #include "whittaker.h"
  32 #include "sharedochiai.h"
  33 #include "sharedanderbergs.h"
  34 #include "sharedkulczynski.h"
  35 #include "sharedkulczynskicody.h"
  36 #include "sharedlennon.h"
  37 #include "sharedmorisitahorn.h"
  38 #include "sharedbraycurtis.h"
  39 #include "sharedjackknife.h"
  40 #include "whittaker.h"
  41 #include "odum.h"
  42 #include "canberra.h"
  43 #include "structeuclidean.h"
  44 #include "structchord.h"
  45 #include "hellinger.h"
  46 #include "manhattan.h"
  47 #include "structpearson.h"
  48 #include "soergel.h"
  49 #include "spearman.h"
  50 #include "structkulczynski.h"
  51 #include "structchi2.h"
  52 #include "speciesprofile.h"
  53 #include "hamming.h"
  54 #include "gower.h"
  55 #include "memchi2.h"
  56 #include "memchord.h"
  57 #include "memeuclidean.h"
  58 #include "mempearson.h"
  59
  60 class SummarySharedCommand : public Command {
  61
  62 public:
  63         SummarySharedCommand(string);
  64         SummarySharedCommand();
  65         ~SummarySharedCommand() {}
  66
  67         vector<string> setParameters();
  68         string getCommandName()                 { return "summary.shared";                      }
  69         string getCommandCategory()             { return "OTU-Based Approaches";        }
  70         string getOutputFileNameTag(string, string);
  71         string getHelpString();
  72         string getCitation() { return "http://www.mothur.org/wiki/Summary.shared"; }
  73         string getDescription()         { return "generate a summary file containing calculator values for each line in the OTU data and for all possible comparisons between groups"; }
  74
  75         int execute();
  76         void help() { m->mothurOut(getHelpString()); }
  77
  78
  79 private:
  80         struct linePair {
  81                 int start;
  82                 int end;
  83         };
  84         vector<linePair> lines;
  85         vector<Calculator*> sumCalculators;
  86         InputData* input;
  87
  88         bool abort, allLines, mult, all, createPhylip, subsample;
  89         set<string> labels; //holds labels to be used
  90         string label, calc, groups, sharedfile, output;
  91         vector<string>  Estimators, Groups, outputNames;
  92         vector<SharedRAbundVector*> lookup;
  93         string format, outputDir;
  94         int numGroups, processors, subsampleSize, iters;
  95         int process(vector<SharedRAbundVector*>, string, string);
  96         int driver(vector<SharedRAbundVector*>, int, int, string, string, vector< vector<seqDist> >&);
  97     int printSims(ostream&, vector< vector<double> >&);
  98
  99 };
 100
 101 /**************************************************************************************************/
 102 //custom data structure for threads to use.
 103 //main process handling the calcs that can do more than 2 groups
 104 // This is passed by void pointer so it can be any data type
 105 // that can be passed using a single void pointer (LPVOID).
 106 struct summarySharedData {
 107     vector<SharedRAbundVector*> thisLookup;
 108     vector< vector<seqDist> > calcDists;
 109     vector<string>  Estimators;
 110         unsigned long long start;
 111         unsigned long long end;
 112         MothurOut* m;
 113         string sumFile;
 114
 115         summarySharedData(){}
 116         summarySharedData(string sf, MothurOut* mout, unsigned long long st, unsigned long long en, vector<string> est, vector<SharedRAbundVector*> lu) {
 117                 sumFile = sf;
 118                 m = mout;
 119                 start = st;
 120                 end = en;
 121         Estimators = est;
 122         thisLookup = lu;
 123         }
 124 };
 125 /**************************************************************************************************/
 126 #if defined (__APPLE__) || (__MACH__) || (linux) || (__linux) || (__linux__) || (__unix__) || (__unix)
 127 #else
 128 static DWORD WINAPI MySummarySharedThreadFunction(LPVOID lpParam){
 129         summarySharedData* pDataArray;
 130         pDataArray = (summarySharedData*)lpParam;
 131
 132         try {
 133
 134         vector<Calculator*> sumCalculators;
 135         ValidCalculators validCalculator;
 136         for (int i=0; i<pDataArray->Estimators.size(); i++) {
 137             if (validCalculator.isValidCalculator("sharedsummary", pDataArray->Estimators[i]) == true) {
 138                 if (pDataArray->Estimators[i] == "sharedsobs") {
 139                     sumCalculators.push_back(new SharedSobsCS());
 140                 }else if (pDataArray->Estimators[i] == "sharedchao") {
 141                     sumCalculators.push_back(new SharedChao1());
 142                 }else if (pDataArray->Estimators[i] == "sharedace") {
 143                     sumCalculators.push_back(new SharedAce());
 144                 }else if (pDataArray->Estimators[i] == "jabund") {
 145                     sumCalculators.push_back(new JAbund());
 146                 }else if (pDataArray->Estimators[i] == "sorabund") {
 147                     sumCalculators.push_back(new SorAbund());
 148                 }else if (pDataArray->Estimators[i] == "jclass") {
 149                     sumCalculators.push_back(new Jclass());
 150                 }else if (pDataArray->Estimators[i] == "sorclass") {
 151                     sumCalculators.push_back(new SorClass());
 152                 }else if (pDataArray->Estimators[i] == "jest") {
 153                     sumCalculators.push_back(new Jest());
 154                 }else if (pDataArray->Estimators[i] == "sorest") {
 155                     sumCalculators.push_back(new SorEst());
 156                 }else if (pDataArray->Estimators[i] == "thetayc") {
 157                     sumCalculators.push_back(new ThetaYC());
 158                 }else if (pDataArray->Estimators[i] == "thetan") {
 159                     sumCalculators.push_back(new ThetaN());
 160                 }else if (pDataArray->Estimators[i] == "kstest") {
 161                     sumCalculators.push_back(new KSTest());
 162                 }else if (pDataArray->Estimators[i] == "sharednseqs") {
 163                     sumCalculators.push_back(new SharedNSeqs());
 164                 }else if (pDataArray->Estimators[i] == "ochiai") {
 165                     sumCalculators.push_back(new Ochiai());
 166                 }else if (pDataArray->Estimators[i] == "anderberg") {
 167                     sumCalculators.push_back(new Anderberg());
 168                 }else if (pDataArray->Estimators[i] == "kulczynski") {
 169                     sumCalculators.push_back(new Kulczynski());
 170                 }else if (pDataArray->Estimators[i] == "kulczynskicody") {
 171                     sumCalculators.push_back(new KulczynskiCody());
 172                 }else if (pDataArray->Estimators[i] == "lennon") {
 173                     sumCalculators.push_back(new Lennon());
 174                 }else if (pDataArray->Estimators[i] == "morisitahorn") {
 175                     sumCalculators.push_back(new MorHorn());
 176                 }else if (pDataArray->Estimators[i] == "braycurtis") {
 177                     sumCalculators.push_back(new BrayCurtis());
 178                 }else if (pDataArray->Estimators[i] == "whittaker") {
 179                     sumCalculators.push_back(new Whittaker());
 180                 }else if (pDataArray->Estimators[i] == "odum") {
 181                     sumCalculators.push_back(new Odum());
 182                 }else if (pDataArray->Estimators[i] == "canberra") {
 183                     sumCalculators.push_back(new Canberra());
 184                 }else if (pDataArray->Estimators[i] == "structeuclidean") {
 185                     sumCalculators.push_back(new StructEuclidean());
 186                 }else if (pDataArray->Estimators[i] == "structchord") {
 187                     sumCalculators.push_back(new StructChord());
 188                 }else if (pDataArray->Estimators[i] == "hellinger") {
 189                     sumCalculators.push_back(new Hellinger());
 190                 }else if (pDataArray->Estimators[i] == "manhattan") {
 191                     sumCalculators.push_back(new Manhattan());
 192                 }else if (pDataArray->Estimators[i] == "structpearson") {
 193                     sumCalculators.push_back(new StructPearson());
 194                 }else if (pDataArray->Estimators[i] == "soergel") {
 195                     sumCalculators.push_back(new Soergel());
 196                 }else if (pDataArray->Estimators[i] == "spearman") {
 197                     sumCalculators.push_back(new Spearman());
 198                 }else if (pDataArray->Estimators[i] == "structkulczynski") {
 199                     sumCalculators.push_back(new StructKulczynski());
 200                 }else if (pDataArray->Estimators[i] == "speciesprofile") {
 201                     sumCalculators.push_back(new SpeciesProfile());
 202                 }else if (pDataArray->Estimators[i] == "hamming") {
 203                     sumCalculators.push_back(new Hamming());
 204                 }else if (pDataArray->Estimators[i] == "structchi2") {
 205                     sumCalculators.push_back(new StructChi2());
 206                 }else if (pDataArray->Estimators[i] == "gower") {
 207                     sumCalculators.push_back(new Gower());
 208                 }else if (pDataArray->Estimators[i] == "memchi2") {
 209                     sumCalculators.push_back(new MemChi2());
 210                 }else if (pDataArray->Estimators[i] == "memchord") {
 211                     sumCalculators.push_back(new MemChord());
 212                 }else if (pDataArray->Estimators[i] == "memeuclidean") {
 213                     sumCalculators.push_back(new MemEuclidean());
 214                 }else if (pDataArray->Estimators[i] == "mempearson") {
 215                     sumCalculators.push_back(new MemPearson());
 216                 }
 217             }
 218         }
 219
 220         pDataArray->calcDists.resize(sumCalculators.size());
 221
 222                 ofstream outputFileHandle;
 223                 pDataArray->m->openOutputFile(pDataArray->sumFile, outputFileHandle);
 224
 225                 vector<SharedRAbundVector*> subset;
 226                 for (int k = pDataArray->start; k < pDataArray->end; k++) { // pass cdd each set of groups to compare
 227
 228                         for (int l = 0; l < k; l++) {
 229
 230                                 outputFileHandle << pDataArray->thisLookup[0]->getLabel() << '\t';
 231
 232                                 subset.clear(); //clear out old pair of sharedrabunds
 233                                 //add new pair of sharedrabunds
 234                                 subset.push_back(pDataArray->thisLookup[k]); subset.push_back(pDataArray->thisLookup[l]);
 235
 236                                 //sort groups to be alphanumeric
 237                                 if (pDataArray->thisLookup[k]->getGroup() > pDataArray->thisLookup[l]->getGroup()) {
 238                                         outputFileHandle << (pDataArray->thisLookup[l]->getGroup() +'\t' + pDataArray->thisLookup[k]->getGroup()) << '\t'; //print out groups
 239                                 }else{
 240                                         outputFileHandle << (pDataArray->thisLookup[k]->getGroup() +'\t' + pDataArray->thisLookup[l]->getGroup()) << '\t'; //print out groups
 241                                 }
 242
 243                                 for(int i=0;i<sumCalculators.size();i++) {
 244
 245                                         //if this calc needs all groups to calculate the pair load all groups
 246                                         if (sumCalculators[i]->getNeedsAll()) {
 247                                                 //load subset with rest of lookup for those calcs that need everyone to calc for a pair
 248                                                 for (int w = 0; w < pDataArray->thisLookup.size(); w++) {
 249                                                         if ((w != k) && (w != l)) { subset.push_back(pDataArray->thisLookup[w]); }
 250                                                 }
 251                                         }
 252
 253                                         vector<double> tempdata = sumCalculators[i]->getValues(subset); //saves the calculator outputs
 254
 255                                         if (pDataArray->m->control_pressed) { for(int i=0;i<sumCalculators.size();i++){  delete sumCalculators[i]; } outputFileHandle.close(); return 1; }
 256
 257                                         outputFileHandle << '\t';
 258                                         sumCalculators[i]->print(outputFileHandle);
 259
 260                                         seqDist temp(l, k, tempdata[0]);
 261                                         pDataArray->calcDists[i].push_back(temp);
 262                                 }
 263                                 outputFileHandle << endl;
 264                         }
 265                 }
 266
 267                 outputFileHandle.close();
 268         for(int i=0;i<sumCalculators.size();i++){  delete sumCalculators[i]; }
 269
 270                 return 0;
 271
 272         }
 273         catch(exception& e) {
 274                 pDataArray->m->errorOut(e, "SummarySharedCommand", "MySummarySharedThreadFunction");
 275                 exit(1);
 276         }
 277 }
 278 #endif
 279
 280
 281 #endif