X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=cooccurrencecommand.cpp;h=b67c6ea02c5b71befcd467127b0db554f124cb4b;hb=fc3b1fc4fc1c4e38fde6b0c0ee7896b5fe0b9d57;hp=fa9f7231228d92585edabe144d9434b04b5be058;hpb=a626c629e4d4840cd2ce04d98055dcfef1f8593a;p=mothur.git diff --git a/cooccurrencecommand.cpp b/cooccurrencecommand.cpp index fa9f723..b67c6ea 100644 --- a/cooccurrencecommand.cpp +++ b/cooccurrencecommand.cpp @@ -33,8 +33,16 @@ vector CooccurrenceCommand::setParameters() { //********************************************************************************************************************** string CooccurrenceCommand::getHelpString(){ try { - string helpString = "help!"; - + string helpString = "The cooccurrence command calculates four metrics and tests their significance to assess whether presence-absence patterns are different than what one would expect by chance."; + helpString += "The cooccurrence command parameters are shared, metric, matrixmodel, iters, label and groups."; + helpString += "The matrixmodel parameter options are sim1, sim2, sim3, sim4, sim5, sim6, sim7, sim8 and sim9. Default=sim2"; + helpString += "The metric parameter options are cscore, checker, combo and vratio. Default=cscore"; + helpString += "The label parameter is used to analyze specific labels in your input.\n"; + helpString += "The groups parameter allows you to specify which of the groups you would like analyzed.\n"; + helpString += "The cooccurrence command should be in the following format: \n"; + helpString += "cooccurrence(shared=yourSharedFile) \n"; + helpString += "Example cooccurrence(shared=final.an.shared).\n"; + helpString += "Note: No spaces between parameter labels (i.e. shared), '=' and parameters (i.e.yourShared).\n"; return helpString; } catch(exception& e) {