summarycommand.h

   1 #ifndef SUMMARYCOMMAND_H
   2 #define SUMMARYCOMMAND_H
   3 /*
   4  *  summarycommand.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 #include <Carbon/Carbon.h>
  13 #include <iostream>
  14 #include <fstream>
  15 #include <vector>
  16 #include "command.hpp"
  17 #include "sabundvector.hpp"
  18 #include "inputdata.h"
  19 #include "calculator.h"
  20 #include "readmatrix.hpp"
  21
  22 /* The summary() command:
  23         The summary command can only be executed after a successful read.list, read.sabund or read.rabund command, with one exception.
  24         The summary command can be executed after a successful cluster command.  It will use the .list file from the output of the cluster.
  25         The summary command outputs a file for each estimator you choose to use.  The summary command parameters are label, line, summary.
  26          No parameters are required, but you may not use both the line and label  parameters at the same time.
  27          The summary command should be in the following format: summary(label=yourLabel, line=yourLines, summary=yourEstimators).
  28          Example summary(label=unique-.01-.03, line=0,5,10, summary=collect-chao-ace-jack-bootstrap-shannon-npshannon-simpson).
  29          The default value for summary is collect-chao-ace-jack-bootstrap-shannon-npshannon-simpson.
  30          The valid summary estimators are: collect-chao-ace-jack-bootstrap-shannon-npshannon-simpson.
  31          The label and line parameters are used to analyze specific lines in your input.  */
  32
  33
  34 class GlobalData;
  35
  36 class SummaryCommand : public Command {
  37
  38 public:
  39         SummaryCommand();
  40         ~SummaryCommand();
  41         int execute();
  42
  43 private:
  44         GlobalData* globaldata;
  45         ReadMatrix* read;
  46         vector<Calculator*> sumCalculators;
  47         InputData* input;
  48         SAbundVector* sabund;
  49         string outputFileName;
  50         ofstream outputFileHandle;
  51 };
  52 #endif