shannonrange.h

   1 //
   2 //  shannonrange.h
   3 //  Mothur
   4 //
   5 //  Created by SarahsWork on 1/3/14.
   6 //  Copyright (c) 2014 Schloss Lab. All rights reserved.
   7 //
   8
   9 /*
  10  1] Haegeman, B., Hamelin, J., Moriarty, J., Neal, P., Dushoff, J., & Weitz, J. S. (2013). Robust estimation of microbial diversity in theory and in practice. The ISME journal, 7(6), 1092–1101.
  11  [2] Hill, M. O. (1973). Diversity and evenness: A unifying notation and its consequences. Ecology, 54(2), 427–432.
  12  [3] Orlitsky, A., Santhanam, N. P., & Zhang, J. (2003). Always Good Turing: Asymptoti- cally optimal probability estimation. Science, 302(5644), 427–431.
  13  [4] Roesch, L. F., Fulthorpe, R. R., Riva, A., Casella, G., Hadwin, A. K., Kent, A. D., et al. (2007). Pyrosequencing enumerates and contrasts soil microbial diversity. The ISME Journal, 1(4), 283–290.
  14  */
  15
  16 #ifndef Mothur_shannonrange_h
  17 #define Mothur_shannonrange_h
  18
  19 #include "calculator.h"
  20
  21 /***********************************************************************/
  22
  23 class RangeShannon : public Calculator  {
  24
  25 public:
  26         RangeShannon(int a) : alpha(a), Calculator("rangeshannon", 3, false) {};
  27         EstOutput getValues(SAbundVector*);
  28         EstOutput getValues(vector<SharedRAbundVector*>) {return data;};
  29         string getCitation() { return "Haegeman, B., Hamelin, J., Moriarty, J., Neal, P., Dushoff, J., & Weitz, J. S. (2013). Robust estimation of microbial diversity in theory and in practice. The ISME journal, 7(6), 1092–1101., http://www.mothur.org/wiki/rangeshannon"; }
  30 private:
  31     int alpha;
  32 };
  33
  34 /***********************************************************************/
  35
  36
  37
  38 #endif