rarefactsharedcommand.h

   1 #ifndef RAREFACTSHAREDCOMMAND_H
   2 #define RAREFACTSHAREDCOMMAND_H
   3 /*
   4  *  rarefactsharedcommand.h
   5  *  Dotur
   6  *
   7  *  Created by Sarah Westcott on 1/6/09.
   8  *  Copyright 2009 Schloss Lab UMASS Amherst. All rights reserved.
   9  *
  10  */
  11
  12 #include "command.hpp"
  13 #include "sharedordervector.h"
  14 #include "sharedlistvector.h"
  15 #include "inputdata.h"
  16 #include "rarefact.h"
  17 #include "display.h"
  18 #include "readotu.h"
  19 #include "validcalculator.h"
  20 #include "sharedutilities.h"
  21
  22 /* The rarefaction.shared() command:
  23         The rarefaction command generates a rarefaction curve from a given file representing several groups.
  24         The rarefaction.shared command can only be executed after a successful read.shared command. It outputs a file for each estimator you choose to use.
  25         The rarefaction.shared command parameters are label, line, iters, jumble and sharedrarefaction.
  26         No parameters are required, but you may not use both the line and label  parameters at the same time.
  27         The rarefaction command should be in the following format: rarefaction.shared(label=yourLabel, line=yourLines, iters=yourIters,
  28         jumble= yourJumble, sharedrarefaction=yourEstimators).  Example rarefaction.shared(label=unique-.01-.03, line=0,5,10, iters=10000,
  29         jumble=1, sharedrarefaction =sharedobserved).  The default values for jumble is 0 (meaning don’t jumble, if it’s set to 1 then it will jumble),
  30         iters is 1000 and sharedrarefaction is sharedobserved which calculates the shared rarefaction curve for the observed richness.
  31          The valid sharedrarefaction estimator is sharedobserved. The label and line parameters are used to analyze specific lines in your input. */
  32
  33
  34 class GlobalData;
  35
  36 class RareFactSharedCommand : public Command {
  37
  38 public:
  39         RareFactSharedCommand();
  40         ~RareFactSharedCommand();
  41         int execute();
  42
  43 private:
  44         GlobalData* globaldata;
  45         SharedUtil* util;
  46         SharedListVector* SharedList;
  47         ReadOTUFile* read;
  48         SharedOrderVector* order;
  49         InputData* input;
  50         ValidCalculators* validCalculator;
  51         Rarefact* rCurve;
  52         vector<Display*> rDisplays;
  53         int freq, nIters;
  54         string format;
  55
  56 };
  57
  58 #endif