]> git.donarmstrong.com Git - mothur.git/blob - helpcommand.h
added files for regularized random forest
[mothur.git] / helpcommand.h
1 #ifndef HELPCOMMAND_H
2 #define HELPCOMMAND_H
3 /*
4  *  helpcommand.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 /* This class is designed to aid the user in running mothur. */
13
14 #include "command.hpp"
15 #include "commandfactory.hpp"
16
17 class HelpCommand : public Command {
18         
19 public:
20         HelpCommand(string);
21         HelpCommand() {}
22         ~HelpCommand(){}
23         
24         vector<string> setParameters()  { return outputNames;   } //dummy, doesn't really do anything   
25         string getCommandName()                 { return "help";                }
26         string getCommandCategory()             { return "Hidden";              }
27         string getHelpString() { return "For more information about a specific command type 'commandName(help)' i.e. 'cluster(help)'"; }        
28     string getOutputFileNameTag(string, string) { return "";  }
29         string getCitation() { return "no citation"; }
30         string getDescription()         { return "help"; }
31
32         int execute(); 
33         void help() { m->mothurOut(getHelpString()); }  
34         
35         
36 private:
37         CommandFactory* validCommands;
38         vector<string> outputNames;     
39                 
40 };
41  
42 #endif