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 "readmatrix.hpp"
  18 #include "sharedlistvector.h"
  19 #include "validcalculator.h"
  20 #include "sharedutilities.h"
  21
  22 /*The summary.shared() command
  23         The summary.shared command can only be executed after a successful read.shared command.
  24         It outputs a file for each estimator you choose to use.  The summary.shared command parameters are label,
  25         line, jumble and sharedsummary.  No parameters are required, but you may not use both the line and label parameters at the same time.
  26         The summary.shared command should be in the following format: summary.shared(label=yourLabel,
  27         line=yourLines, jumble=yourJumble, sharedsummary=yourEstimators).
  28         Example summary.shared(label=unique-.01-.03, line=0,5,10, jumble=1, sharedsummary=sharedChao-sharedAce-sharedJabund
  29         -sharedSorensonAbund-sharedJclass-sharedSorClass-sharedJest-sharedSorEst-SharedThetaYC-SharedThetaN).
  30         The default value for jumble is 0 (meaning don’t jumble, if it’s set to 1 then it will jumble) and
  31         sharedsummary is sharedChao-sharedAce-sharedJabund-sharedSorensonAbund-sharedJclass-sharedSorClass-sharedJest-sharedSorEst-SharedThetaYC-SharedThetaN.
  32         The valid sharedsummary estimators are: sharedChao-sharedAce-sharedJabund-sharedSorensonAbund-sharedJclass-sharedSorClass
  33         -sharedJest-sharedSorEst-SharedThetaYC-SharedThetaN.  The label and line parameters are used to analyze specific lines in your input. */
  34
  35
  36 class GlobalData;
  37
  38
  39 class SummarySharedCommand : public Command {
  40
  41 public:
  42         SummarySharedCommand();
  43         ~SummarySharedCommand();
  44         int execute();
  45
  46 private:
  47         GlobalData* globaldata;
  48         ReadMatrix* read;
  49         SharedUtil* util;
  50         vector<Calculator*> sumCalculators;
  51         InputData* input;
  52         ValidCalculators* validCalculator;
  53         SharedListVector* SharedList;
  54         SharedOrderVector* order;
  55         vector<SharedRAbundVector*> lookup;
  56         string outputFileName, format;
  57         ofstream outputFileHandle;
  58
  59 };
  60
  61 #endif