nmdscommand.h

   1 #ifndef NMDSCOMMAND_H
   2 #define NMDSCOMMAND_H
   3
   4 /*
   5  *  nmdscommand.h
   6  *  mothur
   7  *
   8  *  Created by westcott on 1/11/11.
   9  *  Copyright 2011 Schloss Lab. All rights reserved.
  10  *
  11  */
  12
  13 #include "command.hpp"
  14 #include "linearalgebra.h"
  15
  16
  17 /*
  18  Translated from the nmds.R code written by Sarah Goslee using,
  19
  20  # Non-metric multidimensional scaling function
  21  # using the majorization algorithm from
  22  # Borg & Groenen 1997, Modern Multidimensional Scaling.
  23  #
  24
  25  # also referenced (Kruskal 1964)
  26
  27  */
  28
  29 /*****************************************************************/
  30 class NMDSCommand : public Command {
  31
  32 public:
  33         NMDSCommand(string);
  34         NMDSCommand();
  35         ~NMDSCommand(){}
  36
  37         vector<string> setParameters();
  38         string getCommandName()                 { return "nmds";                                        }
  39         string getCommandCategory()             { return "Hypothesis Testing";          }
  40
  41         string getHelpString();
  42     string getOutputPattern(string);
  43         string getCitation() { return "Borg, Groenen (1997). Non-metric multidimensional scaling function using the majorization algorithm, in Modern Multidimensional Scaling. Ed. T.F. Cox and M.A.A. Cox. Chapman and Hall. \nhttp://www.mothur.org/wiki/Nmds"; }
  44         string getDescription()         { return "nmds"; }
  45
  46         int execute();
  47         void help() { m->mothurOut(getHelpString()); }
  48
  49 private:
  50
  51         bool abort;
  52         string phylipfile, outputDir, axesfile;
  53         int maxdim, mindim, maxIters, iters;
  54         double epsilon;
  55         vector<string> outputNames;
  56         LinearAlgebra linearCalc;
  57
  58         vector< vector<double> > nmdsCalc(vector< vector<double> >&, vector< vector<double> >&, double&);
  59         vector< vector<double> > getConfiguration(vector< vector<double> >&, int);
  60         vector< vector<double> > generateStartingConfiguration(int, int); //pass in numNames, return axes
  61         int normalizeConfiguration(vector< vector<double> >&, int, int);
  62         double calculateStress(vector< vector<double> >&, vector< vector<double> >&);
  63         vector< vector<double> > readAxes(vector<string>);
  64         int output(vector< vector<double> >&, vector<string>&, ofstream&);
  65 };
  66
  67 /*****************************************************************/
  68
  69 #endif
  70
  71