Permalink
Browse files

Fixes help documentation

  • Loading branch information...
1 parent 30d65f3 commit 59b7d0ade37e0d4f1e50ae91862789cafd2342f1 @mothur-westcott mothur-westcott committed Aug 31, 2016
Showing with 2 additions and 2 deletions.
  1. +1 −1 source/commands/clustercommand.cpp
  2. +1 −1 source/commands/clustersplitcommand.cpp
@@ -60,7 +60,7 @@ string ClusterCommand::getHelpString(){
helpString += "The count parameter allows you to enter your count file. \n A count or name file is required if your distance file is in column format.\n";
helpString += "The iters parameter allow you to set the maxiters for the opticluster method. \n";
helpString += "The metric parameter allows to select the metric in the opticluster method. Options are Matthews correlation coefficient (mcc), sensitivity (sens), specificity (spec), true positives + true negatives (tptn), false positives + false negatives (fpfn), true positives (tp), true negative (tn), false positive (fp), false negative (fn), f1score (f1score), accuracy (accuracy), positive predictive value (ppv), negative predictive value (npv), false discovery rate (fdr). Default=mcc.\n";
- helpString += "The initialize parameter allows to select the initial randomization for the opticluster method. Options are singleton, meaning each sequence is randomly assigned to its each OTU, or oneotu meaning all sequences are assigned to oneotu. Default=singleton.\n";
+ helpString += "The initialize parameter allows to select the initial randomization for the opticluster method. Options are singleton, meaning each sequence is randomly assigned to its own OTU, or oneotu meaning all sequences are assigned to one otu. Default=singleton.\n";
helpString += "The delta parameter allows to set the stable value for the metric in the opticluster method (delta=0.0000). \n";
helpString += "The method parameter allows you to enter your clustering mothod. Options are furthest, nearest, average, weighted, agc, dgc and opti. Default=average. The agc and dgc methods require a fasta file.";
helpString += "The processors parameter allows you to specify the number of processors to use. The default is 1.\n";
@@ -74,7 +74,7 @@ string ClusterSplitCommand::getHelpString(){
helpString += "The iters parameter allow you to set the maxiters for the opticluster method. \n";
helpString += "The metric parameter allows to select the metric in the opticluster method. Options are Matthews correlation coefficient (mcc), sensitivity (sens), specificity (spec), true positives + true negatives (tptn), false positives + false negatives (fpfn), true positives (tp), true negative (tn), false positive (fp), false negative (fn), f1score (f1score), accuracy (accuracy), positive predictive value (ppv), negative predictive value (npv), false discovery rate (fdr). Default=mcc.\n";
helpString += "The delta parameter allows to set the stable value for the metric in the opticluster method. Default=0.000\n";
- helpString += "The initialize parameter allows to select the initial randomization for the opticluster method. Options are singleton, meaning each sequence is randomly assigned to its each OTU, or oneotu meaning all sequences are assigned to oneotu. Default=singleton.\n";
+ helpString += "The initialize parameter allows to select the initial randomization for the opticluster method. Options are singleton, meaning each sequence is randomly assigned to its own OTU, or oneotu meaning all sequences are assigned to one otu. Default=singleton.\n";
helpString += "The method parameter allows you to enter your clustering mothod. Options are furthest, nearest, average, weighted, agc, dgc and opti. Default=average. The agc and dgc methods require a fasta file.";
helpString += "The splitmethod parameter allows you to specify how you want to split your distance file before you cluster, default=distance, options distance, classify or fasta. \n";
helpString += "The taxonomy parameter allows you to enter the taxonomy file for your sequences, this is only valid if you are using splitmethod=classify. Be sure your taxonomy file does not include the probability scores. \n";

0 comments on commit 59b7d0a

Please sign in to comment.