added sort to heatmap to put shared otus at the top and updated some error checking

[mothur.git] / helpcommand.cpp

diff --git a/helpcommand.cpp b/helpcommand.cpp
index a0b35d0a34f8ffda7be2c25df53307622fddb65b..cb8785acd54ded4493230cddcb364509b2d92d97 100644 (file)
--- a/helpcommand.cpp
+++ b/helpcommand.cpp
@@ -186,6 +186,16 @@ int HelpCommand::execute(){
                cout << "The default value for groups is all the groups in your groupfile, iters is 10000, cutoff is 1.0, form is integral and step is 0.01." << "\n";
                cout << "The libshuff command output two files: .coverage and .slsummary their descriptions are in the manual." << "\n";
                cout << "Note: No spaces between parameter labels (i.e. iters), '=' and parameters (i.e.yourIters)." << "\n" << "\n";
+       }else if (globaldata->helpRequest == "heatmap") { 
+               cout << "The heatmap command can only be executed after a successful read.otu command." << "\n";
+               cout << "The heatmap command parameters are groups, line and label.  No parameters are required, but you may not use line and label at the same time." << "\n";
+               cout << "The groups parameter allows you to specify which of the groups in your groupfile you would like included in your heatmap." << "\n";
+               cout << "The group names are separated by dashes. The line and label allow you to select what distance levels you would like a heatmap created for, and are also separated by dashes." << "\n";
+               cout << "The heatmap command should be in the following format: heatmap(groups=yourGroups, line=yourLines, label=yourLabels)." << "\n";
+               cout << "Example heatmap(groups=A-B-C, line=1-3-5)." << "\n";
+               cout << "The default value for groups is all the groups in your groupfile, and all lines in your inputfile will be used." << "\n";
+               cout << "The heatmap command outputs a .svg file for each line or label you specify." << "\n";
+               cout << "Note: No spaces between parameter labels (i.e. groups), '=' and parameters (i.e.yourGroups)." << "\n" << "\n";
        }else if (globaldata->helpRequest == "quit") {
                cout << "The quit command will terminate Dotur and should be in the following format: " << "\n";
                cout << "quit()" << "\n" << "\n";