From a44542a3c740cf957cff72ac71742f2fe48b0eaf Mon Sep 17 00:00:00 2001 From: westcott Date: Mon, 20 Jun 2011 16:37:41 +0000 Subject: [PATCH] added command descriptions --- aligncommand.h | 1 + amovacommand.h | 1 + anosimcommand.h | 1 + binsequencecommand.h | 2 +- bootstrapsharedcommand.h | 1 + catchallcommand.h | 3 ++- chimerabellerophoncommand.h | 2 +- chimeraccodecommand.h | 1 + chimeracheckcommand.h | 3 ++- chimerapintailcommand.h | 3 ++- chimeraslayercommand.h | 2 +- chimerauchimecommand.h | 2 +- chopseqscommand.h | 3 ++- classifyotucommand.h | 2 +- classifyseqscommand.h | 2 +- clearcutcommand.h | 1 + clustercommand.h | 1 + clusterdoturcommand.h | 1 + clusterfragmentscommand.h | 1 + clustersplitcommand.h | 1 + collectcommand.h | 1 + collectsharedcommand.h | 3 ++- command.hpp | 1 + consensuscommand.h | 5 +++-- consensusseqscommand.h | 2 ++ corraxescommand.h | 1 + countseqscommand.h | 3 ++- deconvolutecommand.h | 2 ++ degapseqscommand.h | 3 ++- deuniqueseqscommand.h | 2 ++ deuniquetreecommand.h | 1 + distancecommand.h | 3 ++- filterseqscommand.h | 1 + getcommandinfocommand.cpp | 2 ++ getcommandinfocommand.h | 2 ++ getcurrentcommand.h | 2 ++ getgroupcommand.h | 2 ++ getgroupscommand.h | 2 ++ getlabelcommand.h | 2 ++ getlineagecommand.h | 2 ++ getlistcountcommand.h | 2 ++ getoturepcommand.h | 2 ++ getotuscommand.h | 2 ++ getrabundcommand.h | 2 ++ getrelabundcommand.h | 2 ++ getsabundcommand.h | 3 ++- getseqscommand.h | 3 ++- getsharedotucommand.h | 3 ++- hclustercommand.h | 3 ++- heatmapcommand.h | 2 ++ heatmapsimcommand.h | 3 ++- helpcommand.h | 3 ++- homovacommand.h | 3 ++- indicatorcommand.h | 3 ++- libshuffcommand.h | 3 ++- listseqscommand.h | 3 ++- makefastqcommand.h | 2 ++ makegroupcommand.h | 3 ++- mantelcommand.h | 3 ++- matrixoutputcommand.h | 2 ++ mergefilecommand.h | 2 ++ mergegroupscommand.h | 2 ++ metastatscommand.h | 3 ++- mgclustercommand.h | 3 ++- nmdscommand.h | 3 ++- nocommands.h | 2 ++ normalizesharedcommand.h | 2 ++ otuhierarchycommand.h | 2 ++ pairwiseseqscommand.h | 3 ++- parsefastaqcommand.h | 2 ++ parselistscommand.h | 1 + parsimonycommand.h | 3 ++- pcacommand.h | 3 ++- pcoacommand.h | 3 ++- phylodiversitycommand.h | 3 ++- phylotypecommand.h | 3 ++- pipelinepdscommand.h | 2 ++ preclustercommand.h | 2 ++ quitcommand.h | 3 ++- rarefactcommand.h | 3 ++- rarefactsharedcommand.h | 3 ++- readdistcommand.h | 3 ++- readotucommand.h | 1 + readtreecommand.h | 1 + removegroupscommand.h | 1 + removelineagecommand.h | 3 ++- removeotuscommand.h | 3 ++- removerarecommand.h | 2 ++ removeseqscommand.h | 3 ++- reversecommand.h | 2 ++ screenseqscommand.h | 3 ++- secondarystructurecommand.h | 2 ++ sensspeccommand.h | 3 ++- seqerrorcommand.h | 2 ++ seqsummarycommand.h | 1 + setcurrentcommand.h | 3 ++- setdircommand.h | 3 ++- setlogfilecommand.h | 3 ++- sffinfocommand.h | 3 ++- sharedcommand.h | 3 ++- shhhercommand.h | 2 ++ splitabundcommand.h | 1 + splitgroupscommand.h | 2 ++ subsamplecommand.h | 3 ++- summarycommand.h | 2 ++ summarysharedcommand.h | 3 ++- systemcommand.h | 3 ++- treegroupscommand.h | 2 ++ trimflowscommand.h | 2 ++ trimseqscommand.h | 3 ++- unifracunweightedcommand.h | 3 ++- unifracweightedcommand.h | 3 ++- venncommand.h | 3 ++- 113 files changed, 200 insertions(+), 58 deletions(-) diff --git a/aligncommand.h b/aligncommand.h index c014751..952b936 100644 --- a/aligncommand.h +++ b/aligncommand.h @@ -28,6 +28,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "DeSantis TZ, Jr., Hugenholtz P, Keller K, Brodie EL, Larsen N, Piceno YM, Phan R, Andersen GL (2006). NAST: a multiple sequence alignment server for comparative analysis of 16S rRNA genes. Nucleic Acids Res 34: W394-9.\nSchloss PD (2009). A high-throughput DNA sequence aligner for microbial ecology studies. PLoS ONE 4: e8230.\nSchloss PD (2010). The effects of alignment quality, distance calculation method, sequence filtering, and region on the analysis of 16S rRNA gene-based studies. PLoS Comput Biol 6: e1000844.\nhttp://www.mothur.org/wiki/Align.seqs http://www.mothur.org/wiki/Align.seqs"; } + string getDescription() { return "align sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/amovacommand.h b/amovacommand.h index e9ae481..89720d6 100644 --- a/amovacommand.h +++ b/amovacommand.h @@ -25,6 +25,7 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Anderson MJ (2001). A new method for non-parametric multivariate analysis of variance. Austral Ecol 26: 32-46.\nhttp://www.mothur.org/wiki/Amova"; } + string getDescription() { return "calculate AMOVA statistic"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/anosimcommand.h b/anosimcommand.h index 593033d..9f8617a 100644 --- a/anosimcommand.h +++ b/anosimcommand.h @@ -27,6 +27,7 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Clarke, K. R. (1993). Non-parametric multivariate analysis of changes in community structure. _Australian Journal of Ecology_ 18, 117-143.\nhttp://www.mothur.org/wiki/Anosim"; } + string getDescription() { return "anosim"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/binsequencecommand.h b/binsequencecommand.h index 7456a26..365fb3c 100644 --- a/binsequencecommand.h +++ b/binsequencecommand.h @@ -29,7 +29,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Bin.seqs"; } - + string getDescription() { return "maps sequences to otus"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/bootstrapsharedcommand.h b/bootstrapsharedcommand.h index 78b5c31..d5b48e8 100644 --- a/bootstrapsharedcommand.h +++ b/bootstrapsharedcommand.h @@ -32,6 +32,7 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString(); string getCitation() { return "no citation"; } + string getDescription() { return "bootstrap.shared"; } int execute(); diff --git a/catchallcommand.h b/catchallcommand.h index d32989b..238dfb6 100644 --- a/catchallcommand.h +++ b/catchallcommand.h @@ -33,7 +33,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "Bunge, J. (2011). Estimating the number of species with CatchAll. Forthcoming in Proceedings of the Pacific Symposium on Biocomputing 2011.\nhttp://www.northeastern.edu/catchall/index.html http://www.mothur.org/wiki/Catchall"; } - + string getDescription() { return "estimate number of species"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/chimerabellerophoncommand.h b/chimerabellerophoncommand.h index ce85b77..b759d5a 100644 --- a/chimerabellerophoncommand.h +++ b/chimerabellerophoncommand.h @@ -28,7 +28,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "Huber T, Faulkner G, Hugenholtz P (2004). Bellerophon: a program to detect chimeric sequences in multiple sequence alignments. Bioinformatics 20: 2317-9. \nhttp://www.mothur.org/wiki/Chimera.bellerophon"; } - + string getDescription() { return "detect chimeric sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/chimeraccodecommand.h b/chimeraccodecommand.h index 36584e0..2bf7a70 100644 --- a/chimeraccodecommand.h +++ b/chimeraccodecommand.h @@ -28,6 +28,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "Gonzalez JM, Zimmermann J, Saiz-Jimenez C (2005). Evaluating putative chimeric sequences from PCR-amplified products. Bioinformatics 21: 333-7. \nhttp://www.mothur.org/wiki/Chimera.ccode"; } + string getDescription() { return "detect chimeric sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/chimeracheckcommand.h b/chimeracheckcommand.h index 9238871..d29744b 100644 --- a/chimeracheckcommand.h +++ b/chimeracheckcommand.h @@ -29,7 +29,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "CHIMERA_CHECK version 2.7 written by Niels Larsen (http://wdcm.nig.ac.jp/RDP/docs/chimera_doc.html) \nhttp://www.mothur.org/wiki/Chimera.check"; } - + string getDescription() { return "detect chimeric sequences"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/chimerapintailcommand.h b/chimerapintailcommand.h index 8dec0ac..acb0781 100644 --- a/chimerapintailcommand.h +++ b/chimerapintailcommand.h @@ -30,7 +30,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "Ashelford KE, Chuzhanova NA, Fry JC, Jones AJ, Weightman AJ (2005). At least 1 in 20 16S rRNA sequence records currently held in public repositories is estimated to contain substantial anomalies. Appl Environ Microbiol 71: 7724-36. \nAshelford KE, Chuzhanova NA, Fry JC, Jones AJ, Weightman AJ (2006). New screening software shows that most recent large 16S rRNA gene clone libraries contain chimeras. Appl Environ Microbiol 72: 5734-41. \nhttp://www.mothur.org/wiki/Chimera.pintail"; } - + string getDescription() { return "detect chimeric sequences"; } + int execute(); void help() { m->mothurOut(getHelpString()); } private: diff --git a/chimeraslayercommand.h b/chimeraslayercommand.h index 90f6b62..35ff762 100644 --- a/chimeraslayercommand.h +++ b/chimeraslayercommand.h @@ -27,7 +27,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "Haas BJ, Gevers D, Earl A, Feldgarden M, Ward DV, Giannokous G, Ciulla D, Tabbaa D, Highlander SK, Sodergren E, Methe B, Desantis TZ, Petrosino JF, Knight R, Birren BW (2011). Chimeric 16S rRNA sequence formation and detection in Sanger and 454-pyrosequenced PCR amplicons. Genome Res. \nhttp://www.mothur.org/wiki/Chimera.slayer"; } - + string getDescription() { return "detect chimeric sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/chimerauchimecommand.h b/chimerauchimecommand.h index a7d5ad6..7af965b 100644 --- a/chimerauchimecommand.h +++ b/chimerauchimecommand.h @@ -27,7 +27,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "uchime by Robert C. Edgar\nhttp://drive5.com/uchime\nThis code is donated to the public domain.\nhttp://www.mothur.org/wiki/Chimera.uchime"; } - + string getDescription() { return "detect chimeric sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/chopseqscommand.h b/chopseqscommand.h index 31b495b..e73714d 100644 --- a/chopseqscommand.h +++ b/chopseqscommand.h @@ -27,7 +27,8 @@ class ChopSeqsCommand : public Command { string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Chops.seqs"; } - + string getDescription() { return "trim sequence length"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/classifyotucommand.h b/classifyotucommand.h index f6bf78d..b3ca653 100644 --- a/classifyotucommand.h +++ b/classifyotucommand.h @@ -27,7 +27,7 @@ public: string getCommandCategory() { return "Phylotype Analysis"; } string getHelpString(); string getCitation() { return "Schloss PD, Westcott SL (2011). Assessing and improving methods used in OTU-based approaches for 16S rRNA gene sequence analysis. Appl Environ Microbiol. \nhttp://www.mothur.org/wiki/Classify.otu"; } - + string getDescription() { return "find the concensus taxonomy for each OTU"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/classifyseqscommand.h b/classifyseqscommand.h index f075b41..9c8dbca 100644 --- a/classifyseqscommand.h +++ b/classifyseqscommand.h @@ -36,7 +36,7 @@ public: string getCommandCategory() { return "Phylotype Analysis"; } string getHelpString(); string getCitation() { return "Wang Q, Garrity GM, Tiedje JM, Cole JR (2007). Naive Bayesian classifier for rapid assignment of rRNA sequences into the new bacterial taxonomy. Appl Environ Microbiol 73: 5261-7. [ for Bayesian classifier ] \nAltschul SF, Madden TL, Schaffer AA, Zhang J, Zhang Z, Miller W, Lipman DJ (1997). Gapped BLAST and PSI-BLAST: a new generation of protein database search programs. Nucleic Acids Res 25: 3389-402. [ for BLAST ] \nDeSantis TZ, Hugenholtz P, Larsen N, Rojas M, Brodie EL, Keller K, Huber T, Dalevi D, Hu P, Andersen GL (2006). Greengenes, a chimera-checked 16S rRNA gene database and workbench compatible with ARB. Appl Environ Microbiol 72: 5069-72. [ for kmer ] \nhttp://www.mothur.org/wiki/Classify.seqs"; } - + string getDescription() { return "classify sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/clearcutcommand.h b/clearcutcommand.h index ee64724..942953f 100644 --- a/clearcutcommand.h +++ b/clearcutcommand.h @@ -32,6 +32,7 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Sheneman L, Evans J, Foster JA (2006). Clearcut: a fast implementation of relaxed neighbor joining. Bioinformatics 22: 2823-4. \nhttp://www.mothur.org/wiki/Clearcut"; } + string getDescription() { return "create a tree from a fasta or phylip file"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/clustercommand.h b/clustercommand.h index 3dd4410..268ec31 100644 --- a/clustercommand.h +++ b/clustercommand.h @@ -36,6 +36,7 @@ public: string getCommandCategory() { return "Clustering"; } string getHelpString(); string getCitation() { return "Schloss PD, Westcott SL (2011). Assessing and improving methods used in OTU-based approaches for 16S rRNA gene sequence analysis. Appl Environ Microbiol. \nhttp://www.mothur.org/wiki/Cluster"; } + string getDescription() { return "cluster your sequences into OTUs using a distance matrix"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/clusterdoturcommand.h b/clusterdoturcommand.h index 42be4a6..3a32349 100644 --- a/clusterdoturcommand.h +++ b/clusterdoturcommand.h @@ -29,6 +29,7 @@ public: string getCommandCategory() { return "Clustering"; } string getHelpString(); string getCitation() { return "Schloss PD, Handelsman J (2005). Introducing DOTUR, a computer program for defining operational taxonomic units and estimating species richness. Appl Environ Microbiol 71: 1501-6. \nhttp://www.mothur.org/wiki/Cluster.classic"; } + string getDescription() { return "cluster your sequences into OTUs using dotur's method"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/clusterfragmentscommand.h b/clusterfragmentscommand.h index 2b02947..c7ea7e0 100644 --- a/clusterfragmentscommand.h +++ b/clusterfragmentscommand.h @@ -39,6 +39,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Cluster.fragments"; } + string getDescription() { return "creates a namesfile with sequences that are a fragment of a larger sequence"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/clustersplitcommand.h b/clustersplitcommand.h index c115283..c4b236c 100644 --- a/clustersplitcommand.h +++ b/clustersplitcommand.h @@ -30,6 +30,7 @@ public: string getCommandCategory() { return "Clustering"; } string getHelpString(); string getCitation() { return "Schloss PD, Westcott SL (2011). Assessing and improving methods used in OTU-based approaches for 16S rRNA gene sequence analysis. Appl Environ Microbiol. \nhttp://www.mothur.org/wiki/Cluster.split"; } + string getDescription() { return "splits your sequences by distance or taxonomy then clusters into OTUs"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/collectcommand.h b/collectcommand.h index 9e51398..b882013 100644 --- a/collectcommand.h +++ b/collectcommand.h @@ -39,6 +39,7 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getCitation() { return "Schloss PD, Handelsman J (2006). Introducing SONS, A tool that compares the membership of microbial communities. Appl Environ Microbiol 72: 6773-9. \nhttp://www.mothur.org/wiki/Collect.single"; } string getHelpString(); + string getDescription() { return "generates collector's curves using calculators, that describe the richness, diversity, and other features of individual samples"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/collectsharedcommand.h b/collectsharedcommand.h index 3eb56fe..71c11d6 100644 --- a/collectsharedcommand.h +++ b/collectsharedcommand.h @@ -31,7 +31,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "Schloss PD, Handelsman J (2006). Introducing SONS, A tool that compares the membership of microbial communities. Appl Environ Microbiol 72: 6773-9. \nhttp://www.mothur.org/wiki/Collect.shared"; } - + string getDescription() { return "generates collector's curves for calculators, which describe the similarity between communities or their shared richness"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/command.hpp b/command.hpp index a0bb001..04285fe 100644 --- a/command.hpp +++ b/command.hpp @@ -30,6 +30,7 @@ class Command { virtual string getCommandCategory() = 0; virtual string getHelpString() = 0; virtual string getCitation() = 0; + virtual string getDescription() = 0; virtual map > getOutputFiles() { return outputTypes; } virtual vector setParameters() = 0; //to fill parameters diff --git a/consensuscommand.h b/consensuscommand.h index fdad93a..a987851 100644 --- a/consensuscommand.h +++ b/consensuscommand.h @@ -22,11 +22,12 @@ public: ~ConcensusCommand() {} vector setParameters(); - string getCommandName() { return "concensus"; } + string getCommandName() { return "consensus"; } string getCommandCategory() { return "Hidden"; } string getHelpString(); string getCitation() { return "no citation"; } - + string getDescription() { return "consensus"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/consensusseqscommand.h b/consensusseqscommand.h index fd2f4f5..6542b70 100644 --- a/consensusseqscommand.h +++ b/consensusseqscommand.h @@ -25,6 +25,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Consensus.seqs"; } + string getDescription() { return "create a consensus sequence for each OTU or for a fasta file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/corraxescommand.h b/corraxescommand.h index 45b6989..2aa7ae0 100644 --- a/corraxescommand.h +++ b/corraxescommand.h @@ -26,6 +26,7 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "McCune B, Grace JB, Urban DL (2002). Analysis of ecological communities. MjM Software Design: Gleneden Beach, OR. \nLegendre P, Legendre L (1998). Numerical Ecology. Elsevier: New York. \nhttp://www.mothur.org/wiki/Corr.axes"; } + string getDescription() { return "calculate the correlation coefficient for each column in a shared/relabund file to the axes displayed in a pcoa file"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/countseqscommand.h b/countseqscommand.h index 385cd13..89549a9 100644 --- a/countseqscommand.h +++ b/countseqscommand.h @@ -25,7 +25,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Count.seqs"; } - + string getDescription() { return "counts the number of sequences represented by each unique sequence in a namesfile"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/deconvolutecommand.h b/deconvolutecommand.h index 21a0081..487c460 100644 --- a/deconvolutecommand.h +++ b/deconvolutecommand.h @@ -28,6 +28,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Unique.seqs"; } + string getDescription() { return "creates a fasta containing the unique sequences as well as a namesfile with the names each sequence represents"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/degapseqscommand.h b/degapseqscommand.h index 0bf0a57..342cd36 100644 --- a/degapseqscommand.h +++ b/degapseqscommand.h @@ -24,7 +24,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Degap.seqs"; } - + string getDescription() { return "removes gap characters from sequences"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/deuniqueseqscommand.h b/deuniqueseqscommand.h index a8edea2..300a1ca 100644 --- a/deuniqueseqscommand.h +++ b/deuniqueseqscommand.h @@ -25,6 +25,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Deunique.seqs"; } + string getDescription() { return "reverse of the unique.seqs command, and creates a fasta file from a fasta and name file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/deuniquetreecommand.h b/deuniquetreecommand.h index 5131c11..6d72253 100644 --- a/deuniquetreecommand.h +++ b/deuniquetreecommand.h @@ -28,6 +28,7 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Deunique.tree"; } + string getDescription() { return "add the redundant sequence names back into a tree of unique sequences"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/distancecommand.h b/distancecommand.h index 81267d1..bac5d14 100644 --- a/distancecommand.h +++ b/distancecommand.h @@ -29,7 +29,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "Schloss PD (2010). The effects of alignment quality, distance calculation method, sequence filtering, and region on the analysis of 16S rRNA gene-based studies. PLoS Comput Biol 6: e1000844. \nhttp://www.mothur.org/wiki/Dist.seqs"; } - + string getDescription() { return "calculate the pairwaise distances between aligned sequences"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/filterseqscommand.h b/filterseqscommand.h index 809c6eb..e445023 100644 --- a/filterseqscommand.h +++ b/filterseqscommand.h @@ -26,6 +26,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Filter.seqs"; } + string getDescription() { return "removes columns from alignments based on a criteria defined by the user"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getcommandinfocommand.cpp b/getcommandinfocommand.cpp index 52559b3..ad706ef 100644 --- a/getcommandinfocommand.cpp +++ b/getcommandinfocommand.cpp @@ -121,6 +121,8 @@ int GetCommandInfoCommand::execute(){ } out << "citation=" << newCitationString << endl; + out << "description=" << thisCommand->getDescription() << endl; + //outputTypes - makes something like outputTypes=fasta-name-qfile map > thisOutputTypes = thisCommand->getOutputFiles(); map >::iterator itTypes; diff --git a/getcommandinfocommand.h b/getcommandinfocommand.h index c67a4ed..463c94c 100644 --- a/getcommandinfocommand.h +++ b/getcommandinfocommand.h @@ -29,6 +29,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString(); string getCitation() { return "no citation"; } + string getDescription() { return "get.commandinfo"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getcurrentcommand.h b/getcurrentcommand.h index bfa9168..dfff0fa 100644 --- a/getcurrentcommand.h +++ b/getcurrentcommand.h @@ -24,6 +24,8 @@ class GetCurrentCommand : public Command { string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.current"; } + string getDescription() { return "get current files saved by mothur"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getgroupcommand.h b/getgroupcommand.h index a539834..a3e47e0 100644 --- a/getgroupcommand.h +++ b/getgroupcommand.h @@ -23,6 +23,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.group"; } + string getDescription() { return "outputs group names"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getgroupscommand.h b/getgroupscommand.h index fda603c..642107d 100644 --- a/getgroupscommand.h +++ b/getgroupscommand.h @@ -27,6 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.groups"; } + string getDescription() { return "gets sequences from a list, fasta, name, group or taxonomy file from a given group or set of groups"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getlabelcommand.h b/getlabelcommand.h index 7164570..c5dc1a1 100644 --- a/getlabelcommand.h +++ b/getlabelcommand.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.label"; } + string getDescription() { return "outputs labels"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getlineagecommand.h b/getlineagecommand.h index ca84bf2..4c9514d 100644 --- a/getlineagecommand.h +++ b/getlineagecommand.h @@ -25,6 +25,8 @@ class GetLineageCommand : public Command { string getCommandCategory() { return "Phylotype Analysis"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.lineage"; } + string getDescription() { return "gets sequences from a list, fasta, name, group, alignreport or taxonomy file from a given taxonomy or set of taxonomies"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getlistcountcommand.h b/getlistcountcommand.h index a0b5f09..7a0c109 100644 --- a/getlistcountcommand.h +++ b/getlistcountcommand.h @@ -26,6 +26,8 @@ public: string getCommandName() { return "get.otulist"; } string getCommandCategory() { return "OTU-Based Approaches"; } string getCitation() { return "http://www.mothur.org/wiki/Get.otulist"; } + string getDescription() { return "lists each OTU number and the sequence contained in that OTU"; } + string getHelpString(); int execute(); diff --git a/getoturepcommand.h b/getoturepcommand.h index 179a1b3..07cccde 100644 --- a/getoturepcommand.h +++ b/getoturepcommand.h @@ -45,6 +45,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.oturep"; } + string getDescription() { return "gets a representative sequence for each OTU"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getotuscommand.h b/getotuscommand.h index 30f4f3c..1a78493 100644 --- a/getotuscommand.h +++ b/getotuscommand.h @@ -29,6 +29,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.otus"; } + string getDescription() { return "outputs a new list file containing the otus containing sequences from the groups specified"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getrabundcommand.h b/getrabundcommand.h index 81a5d91..cb9e270 100644 --- a/getrabundcommand.h +++ b/getrabundcommand.h @@ -27,6 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.rabund"; } + string getDescription() { return "creates a rabund file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getrelabundcommand.h b/getrelabundcommand.h index 0df0e7d..1d5163d 100644 --- a/getrelabundcommand.h +++ b/getrelabundcommand.h @@ -27,6 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.relabund"; } + string getDescription() { return "calculates the relative abundance of each OTU in a sample"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getsabundcommand.h b/getsabundcommand.h index da998f5..5be00df 100644 --- a/getsabundcommand.h +++ b/getsabundcommand.h @@ -26,7 +26,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.sabund"; } - + string getDescription() { return "creates a sabund file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getseqscommand.h b/getseqscommand.h index 4fef8e7..4561d28 100644 --- a/getseqscommand.h +++ b/getseqscommand.h @@ -25,7 +25,8 @@ class GetSeqsCommand : public Command { string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.seqs"; } - + string getDescription() { return "gets sequences from a list, fasta, name, group, alignreport, quality or taxonomy file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/getsharedotucommand.h b/getsharedotucommand.h index d7ffef3..ea6ed94 100644 --- a/getsharedotucommand.h +++ b/getsharedotucommand.h @@ -30,7 +30,8 @@ class GetSharedOTUCommand : public Command { string getRequiredCommand() { return "none"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Get.sharedseqs"; } - + string getDescription() { return "identifies sequences that are either unique or shared by specific groups"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/hclustercommand.h b/hclustercommand.h index adf9f25..aeeb3bc 100644 --- a/hclustercommand.h +++ b/hclustercommand.h @@ -40,7 +40,8 @@ public: string getCommandCategory() { return "Clustering"; } string getHelpString(); string getCitation() { return "Sun Y, Cai Y, Liu L, Yu F, Farrell ML, Mckendree W, Farmerie W (2009). ESPRIT: estimating species richness using large collections of 16S rRNA pyrosequences. Nucleic Acids Res 37: e76. \nhttp://www.mothur.org/wiki/Hcluster"; } - + string getDescription() { return "cluster your sequences into OTUs using a distance matrix"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/heatmapcommand.h b/heatmapcommand.h index 3bb9791..ccd5f48 100644 --- a/heatmapcommand.h +++ b/heatmapcommand.h @@ -30,6 +30,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Heatmap.bin"; } + string getDescription() { return "generate a heatmap where the color represents the relative abundanceof an OTU"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/heatmapsimcommand.h b/heatmapsimcommand.h index ba5a240..dd6fa2c 100644 --- a/heatmapsimcommand.h +++ b/heatmapsimcommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Heatmap.sim"; } - + string getDescription() { return "generate a heatmap indicating the pairwise distance between multiple samples using a variety of calculators"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/helpcommand.h b/helpcommand.h index c542899..cba0708 100644 --- a/helpcommand.h +++ b/helpcommand.h @@ -26,7 +26,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString() { return "For more information about a specific command type 'commandName(help)' i.e. 'cluster(help)'"; } string getCitation() { return "no citation"; } - + string getDescription() { return "help"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/homovacommand.h b/homovacommand.h index d9daa0e..4afaeb8 100644 --- a/homovacommand.h +++ b/homovacommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Stewart CN, Excoffier L (1996). Assessing population genetic structure and variability with RAPD data: Application to Vaccinium macrocarpon (American Cranberry). J Evol Biol 9: 153-71. \nhttp://www.mothur.org/wiki/Homova"; } - + string getDescription() { return "homova"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/indicatorcommand.h b/indicatorcommand.h index 578aa95..00694be 100644 --- a/indicatorcommand.h +++ b/indicatorcommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Dufrene M, Legendre P (1997). Species assemblages and indicator species: The need for a flexible asymmetrical approach. Ecol Monogr 67: 345-66.\n McCune B, Grace JB, Urban DL (2002). Analysis of ecological communities. MjM Software Design: Gleneden Beach, OR. \nLegendre P, Legendre L (1998). Numerical Ecology. Elsevier: New York. \nhttp://www.mothur.org/wiki/Indicator"; } - + string getDescription() { return "calculate the indicator value for each OTU for each tree node"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/libshuffcommand.h b/libshuffcommand.h index 96e68f3..465a67f 100644 --- a/libshuffcommand.h +++ b/libshuffcommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Singleton DR, Furlong MA, Rathbun SL, Whitman WB (2001). Quantitative comparisons of 16S rRNA gene sequence libraries from environmental samples. Appl Environ Microbiol 67: 4374-6. \nSchloss PD, Larget BR, Handelsman J (2004). Integration of microbial ecology and statistics: a test to compare gene libraries. Appl Environ Microbiol 70: 5485-92. \nhttp://www.mothur.org/wiki/Libshuff"; } - + string getDescription() { return "a generic test that describes whether two or more communities have the same structure using the Cramer-von Mises test statistic"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/listseqscommand.h b/listseqscommand.h index ea48430..f814d84 100644 --- a/listseqscommand.h +++ b/listseqscommand.h @@ -25,7 +25,8 @@ class ListSeqsCommand : public Command { string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/List.seqs"; } - + string getDescription() { return "lists sequences from a list, fasta, name, group, alignreport or taxonomy file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/makefastqcommand.h b/makefastqcommand.h index 085654f..1c209aa 100644 --- a/makefastqcommand.h +++ b/makefastqcommand.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Make.fastq"; } + string getDescription() { return "creates a fastq file from a fasta and quality file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/makegroupcommand.h b/makegroupcommand.h index f5fb358..e0c7092 100644 --- a/makegroupcommand.h +++ b/makegroupcommand.h @@ -24,7 +24,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Make.group"; } - + string getDescription() { return "creates a group file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/mantelcommand.h b/mantelcommand.h index 5b2fe6f..adffda8 100644 --- a/mantelcommand.h +++ b/mantelcommand.h @@ -24,7 +24,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "McCune B, Grace JB, Urban DL (2002). Analysis of ecological communities. MjM Software Design: Gleneden Beach, OR. \nLegendre P, Legendre L (1998). Numerical Ecology. Elsevier: New York. \nhttp://www.mothur.org/wiki/Mantel"; } - + string getDescription() { return "mantel"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/matrixoutputcommand.h b/matrixoutputcommand.h index b42cfb9..ae38b46 100644 --- a/matrixoutputcommand.h +++ b/matrixoutputcommand.h @@ -33,6 +33,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Dist.shared"; } + string getDescription() { return "generate a distance matrix that describes the dissimilarity among multiple groups"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/mergefilecommand.h b/mergefilecommand.h index 1e56f73..1c3c4d5 100644 --- a/mergefilecommand.h +++ b/mergefilecommand.h @@ -24,6 +24,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Merge.files"; } + string getDescription() { return "appends files creating one file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/mergegroupscommand.h b/mergegroupscommand.h index dfd65ad..7907dfe 100644 --- a/mergegroupscommand.h +++ b/mergegroupscommand.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Merge.groups"; } + string getDescription() { return "reads shared file and a design file and merges the groups in the shared file that are in the same grouping in the design file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/metastatscommand.h b/metastatscommand.h index 04c3443..88e32ac 100644 --- a/metastatscommand.h +++ b/metastatscommand.h @@ -26,7 +26,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "White JR, Nagarajan N, Pop M (2009). Statistical methods for detecting differentially abundant features in clinical metagenomic samples. PLoS Comput Biol 5: e1000352. \nhttp://www.mothur.org/wiki/Metastats"; } - + string getDescription() { return "detects differentially abundant features in clinical metagenomic samples"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/mgclustercommand.h b/mgclustercommand.h index 6ad1855..df0c526 100644 --- a/mgclustercommand.h +++ b/mgclustercommand.h @@ -33,7 +33,8 @@ public: string getCommandCategory() { return "Clustering"; } string getHelpString(); string getCitation() { return "Schloss PD, Handelsman J (2008). A statistical toolbox for metagenomics. BMC Bioinformatics 9: 34. \nhttp://www.mothur.org/wiki/Mgcluster"; } - + string getDescription() { return "cluster your sequences into OTUs using a blast file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/nmdscommand.h b/nmdscommand.h index 0b7f5a8..c05c9fe 100644 --- a/nmdscommand.h +++ b/nmdscommand.h @@ -39,7 +39,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); 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"; } - + string getDescription() { return "nmds"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/nocommands.h b/nocommands.h index b7fa6f1..5ed7e12 100644 --- a/nocommands.h +++ b/nocommands.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString() { return "No Command"; } string getCitation() { return "no citation"; } + string getDescription() { return "no description"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/normalizesharedcommand.h b/normalizesharedcommand.h index 6332fd7..c252741 100644 --- a/normalizesharedcommand.h +++ b/normalizesharedcommand.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Normalize.shared"; } + string getDescription() { return "normalize samples in a shared or relabund file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/otuhierarchycommand.h b/otuhierarchycommand.h index 342b5aa..8a2c862 100644 --- a/otuhierarchycommand.h +++ b/otuhierarchycommand.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Otu.hierarchy"; } + string getDescription() { return "relates OTUs at different distances"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/pairwiseseqscommand.h b/pairwiseseqscommand.h index cbd5aa4..afb8e19 100644 --- a/pairwiseseqscommand.h +++ b/pairwiseseqscommand.h @@ -30,7 +30,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "Needleman SB, Wunsch CD (1970). A general method applicable to the search for similarities in the amino acid sequence of two proteins. J Mol Biol 48: 443-53. [ for needleman ]\nGotoh O (1982). An improved algorithm for matching biological sequences. J Mol Biol 162: 705-8. [ for gotoh ] \nhttp://www.mothur.org/wiki/Pairwise.seqs"; } - + string getDescription() { return "calculates pairwise distances from an unaligned fasta file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/parsefastaqcommand.h b/parsefastaqcommand.h index dfafca6..6052456 100644 --- a/parsefastaqcommand.h +++ b/parsefastaqcommand.h @@ -25,6 +25,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Parse.fastq"; } + string getDescription() { return "reads a fastq file and creates a fasta and quality file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/parselistscommand.h b/parselistscommand.h index 9489b9b..9356299 100644 --- a/parselistscommand.h +++ b/parselistscommand.h @@ -28,6 +28,7 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Parse.list"; } + string getDescription() { return "parses a list file by group"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/parsimonycommand.h b/parsimonycommand.h index 5e5484f..81fa99b 100644 --- a/parsimonycommand.h +++ b/parsimonycommand.h @@ -30,7 +30,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Slatkin M, Maddison WP (1989). A cladistic measure of gene flow inferred from the phylogenies of alleles. Genetics 123: 603-13. \nSlatkin M, Maddison WP (1990). Detecting isolation by distance using phylogenies of genes. Genetics 126: 249-60. \nMartin AP (2002). Phylogenetic approaches for describing and comparing the diversity of microbial communities. Appl Environ Microbiol 68: 3673-82. \nSchloss PD, Handelsman J (2006). Introducing TreeClimber, a test to compare microbial community structure. Appl Environ Microbiol 72: 2379-84.\nhttp://www.mothur.org/wiki/Parsimony"; } - + string getDescription() { return "generic test that describes whether two or more communities have the same structure"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/pcacommand.h b/pcacommand.h index f139214..d16e896 100644 --- a/pcacommand.h +++ b/pcacommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "McCune B, Grace JB, Urban DL (2002). Analysis of ecological communities. MjM Software Design: Gleneden Beach, OR. \nLegendre P, Legendre L (1998). Numerical Ecology. Elsevier: New York. \nhttp://www.mothur.org/wiki/Pca"; } - + string getDescription() { return "pca"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/pcoacommand.h b/pcoacommand.h index 5b84d48..3d24f6a 100644 --- a/pcoacommand.h +++ b/pcoacommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "McCune B, Grace JB, Urban DL (2002). Analysis of ecological communities. MjM Software Design: Gleneden Beach, OR. \nLegendre P, Legendre L (1998). Numerical Ecology. Elsevier: New York. \nhttp://www.mothur.org/wiki/Pcoa"; } - + string getDescription() { return "pcoa"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/phylodiversitycommand.h b/phylodiversitycommand.h index 52295cf..b44e6ca 100644 --- a/phylodiversitycommand.h +++ b/phylodiversitycommand.h @@ -28,7 +28,8 @@ class PhyloDiversityCommand : public Command { string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Faith DP (1994). Phylogenetic pattern and the quantification of organismal biodiversity. Philos Trans R Soc Lond B Biol Sci 345: 45-58. \nhttp://www.mothur.org/wiki/Phylo.diversity"; } - + string getDescription() { return "phylo.diversity"; } + int execute(); void help() { m->mothurOut(getHelpString()); } private: diff --git a/phylotypecommand.h b/phylotypecommand.h index a041130..ecc7376 100644 --- a/phylotypecommand.h +++ b/phylotypecommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "Clustering"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Phylotype"; } - + string getDescription() { return "cluster your sequences into OTUs based on their classifications"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/pipelinepdscommand.h b/pipelinepdscommand.h index c4b4646..8abe0ea 100644 --- a/pipelinepdscommand.h +++ b/pipelinepdscommand.h @@ -28,6 +28,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Pipeline.pds"; } + string getDescription() { return "pat's pipeline"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/preclustercommand.h b/preclustercommand.h index 8302fed..3a12413 100644 --- a/preclustercommand.h +++ b/preclustercommand.h @@ -39,6 +39,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Pre.cluster"; } + string getDescription() { return "implements a pseudo-single linkage algorithm with the goal of removing sequences that are likely due to pyrosequencing errors"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/quitcommand.h b/quitcommand.h index f1929bf..6495800 100644 --- a/quitcommand.h +++ b/quitcommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString() { return "The quit command will terminate mothur and should be in the following format: quit() or quit. \n"; } string getCitation() { return "no citation"; } - + string getDescription() { return "quit"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/rarefactcommand.h b/rarefactcommand.h index 0bf8a45..b4bce3e 100644 --- a/rarefactcommand.h +++ b/rarefactcommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "Magurran AE (2004). Measuring biological diversity. Blackwell Pub.: Malden, Ma. \nhttp://www.mothur.org/wiki/Rarefaction.single"; } - + string getDescription() { return "generate intra-sample rarefaction curves using a re-sampling without replacement approach"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/rarefactsharedcommand.h b/rarefactsharedcommand.h index 7d4dc5e..2112e8d 100644 --- a/rarefactsharedcommand.h +++ b/rarefactsharedcommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "Magurran AE (2004). Measuring biological diversity. Blackwell Pub.: Malden, Ma. \nhttp://www.mothur.org/wiki/Rarefaction.shared"; } - + string getDescription() { return "generate inter-sample rarefaction curves using a re-sampling without replacement approach"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/readdistcommand.h b/readdistcommand.h index eaa4484..afe077d 100644 --- a/readdistcommand.h +++ b/readdistcommand.h @@ -33,7 +33,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString() { return "This command is no longer available. You can provide your distance files directly to the downstream commands like cluster."; } string getCitation() { return "http://www.mothur.org/wiki/Read.dist"; } - + string getDescription() { return "read.dist"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/readotucommand.h b/readotucommand.h index 0f6644b..c6d6503 100644 --- a/readotucommand.h +++ b/readotucommand.h @@ -25,6 +25,7 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString() { return "This command is no longer available. You can provide your files directly to the downstream commands like collect.shared."; } string getCitation() { return "http://www.mothur.org/wiki/Read.otu"; } + string getDescription() { return "read.otu"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/readtreecommand.h b/readtreecommand.h index 70d3c6e..cbf3769 100644 --- a/readtreecommand.h +++ b/readtreecommand.h @@ -26,6 +26,7 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString() { return "This command is no longer available. You can provide your files directly to the downstream commands like unifrac.unweighted."; } string getCitation() { return "http://www.mothur.org/wiki/Read.tree"; } + string getDescription() { return "read.tree"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/removegroupscommand.h b/removegroupscommand.h index ce352ca..daf2066 100644 --- a/removegroupscommand.h +++ b/removegroupscommand.h @@ -27,6 +27,7 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Remove.groups"; } + string getDescription() { return "removes sequences from a list, fasta, name, group or taxonomy file from a given group or set of groups"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/removelineagecommand.h b/removelineagecommand.h index 310a66a..bda398b 100644 --- a/removelineagecommand.h +++ b/removelineagecommand.h @@ -25,7 +25,8 @@ class RemoveLineageCommand : public Command { string getCommandCategory() { return "Phylotype Analysis"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Remove.lineage"; } - + string getDescription() { return "removes sequences from a list, fasta, name, group, alignreport or taxonomy file from a given taxonomy or set of taxonomies"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/removeotuscommand.h b/removeotuscommand.h index cb017b4..6a7cf8a 100644 --- a/removeotuscommand.h +++ b/removeotuscommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Remove.otus"; } - + string getDescription() { return "outputs a new list file containing the otus NOT containing sequences from the groups specified"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/removerarecommand.h b/removerarecommand.h index 2ab1272..9e58c06 100644 --- a/removerarecommand.h +++ b/removerarecommand.h @@ -28,6 +28,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Remove.rare"; } + string getDescription() { return "removes rare sequences from a sabund, rabund, shared or list and group file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/removeseqscommand.h b/removeseqscommand.h index b89a509..df96e45 100644 --- a/removeseqscommand.h +++ b/removeseqscommand.h @@ -25,7 +25,8 @@ class RemoveSeqsCommand : public Command { string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Remove.seqs"; } - + string getDescription() { return "removes sequences from a list, fasta, name, group, alignreport, quality or taxonomy file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/reversecommand.h b/reversecommand.h index 2e4719a..f0fdfa8 100644 --- a/reversecommand.h +++ b/reversecommand.h @@ -23,6 +23,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Reverse.seqs"; } + string getDescription() { return "outputs a fasta file containing the reverse-complements"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/screenseqscommand.h b/screenseqscommand.h index b165bba..3642295 100644 --- a/screenseqscommand.h +++ b/screenseqscommand.h @@ -24,7 +24,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Screen.seqs"; } - + string getDescription() { return "enables you to keep sequences that fulfill certain user defined criteria"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/secondarystructurecommand.h b/secondarystructurecommand.h index daee85a..4e7bdea 100644 --- a/secondarystructurecommand.h +++ b/secondarystructurecommand.h @@ -41,6 +41,8 @@ class AlignCheckCommand : public Command { string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Align.check"; } + string getDescription() { return "calculate the number of potentially misaligned bases in a 16S rRNA gene sequence alignment"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/sensspeccommand.h b/sensspeccommand.h index 47d6e4e..1631e74 100644 --- a/sensspeccommand.h +++ b/sensspeccommand.h @@ -26,7 +26,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "Schloss PD, Westcott SL (2011). Assessing and improving methods used in OTU-based approaches for 16S rRNA gene sequence analysis. Appl Environ Microbiol. \nhttp://www.mothur.org/wiki/Sens.spec"; } - + string getDescription() { return "sens.spec"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/seqerrorcommand.h b/seqerrorcommand.h index 3fdd669..e467df1 100644 --- a/seqerrorcommand.h +++ b/seqerrorcommand.h @@ -50,6 +50,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Seq.error"; } + string getDescription() { return "seq.error"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/seqsummarycommand.h b/seqsummarycommand.h index 4bf6759..c0d3687 100644 --- a/seqsummarycommand.h +++ b/seqsummarycommand.h @@ -24,6 +24,7 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Summary.seqs"; } + string getDescription() { return "summarize the quality of sequences in an unaligned or aligned fasta file"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/setcurrentcommand.h b/setcurrentcommand.h index e942e60..0033ed5 100644 --- a/setcurrentcommand.h +++ b/setcurrentcommand.h @@ -25,7 +25,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Set.current"; } - + string getDescription() { return "set current files for mothur"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/setdircommand.h b/setdircommand.h index 625c83b..b3b00c4 100644 --- a/setdircommand.h +++ b/setdircommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Set.dir"; } - + string getDescription() { return "set input, output and default directories"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/setlogfilecommand.h b/setlogfilecommand.h index d187c07..8d3bfcd 100644 --- a/setlogfilecommand.h +++ b/setlogfilecommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Set.logfile"; } - + string getDescription() { return "set logfile name"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/sffinfocommand.h b/sffinfocommand.h index abfaa4b..f18a3f5 100644 --- a/sffinfocommand.h +++ b/sffinfocommand.h @@ -71,7 +71,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Sffinfo"; } - + string getDescription() { return "extract sequences reads from a .sff file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/sharedcommand.h b/sharedcommand.h index add6ee8..51a2528 100644 --- a/sharedcommand.h +++ b/sharedcommand.h @@ -32,7 +32,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Make.shared"; } - + string getDescription() { return "make a shared file from a list and group file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/shhhercommand.h b/shhhercommand.h index a95815f..bdc8503 100644 --- a/shhhercommand.h +++ b/shhhercommand.h @@ -26,6 +26,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString(); string getCitation() { return "no citation"; } + string getDescription() { return "shhh.seqs"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/splitabundcommand.h b/splitabundcommand.h index 444b55e..df925f3 100644 --- a/splitabundcommand.h +++ b/splitabundcommand.h @@ -37,6 +37,7 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Split.abund"; } + string getDescription() { return "split a list, name, group or fasta file based on abundance"; } int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/splitgroupscommand.h b/splitgroupscommand.h index a9a6343..f8bdca1 100644 --- a/splitgroupscommand.h +++ b/splitgroupscommand.h @@ -32,6 +32,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Split.group"; } + string getDescription() { return "split a name or fasta file by group"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/subsamplecommand.h b/subsamplecommand.h index 5656dab..39d3c37 100644 --- a/subsamplecommand.h +++ b/subsamplecommand.h @@ -30,7 +30,8 @@ public: string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Sub.sample"; } - + string getDescription() { return "get a sampling of sequences from a list, shared, rabund, sabund or fasta file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/summarycommand.h b/summarycommand.h index e79f3e1..15b7f40 100644 --- a/summarycommand.h +++ b/summarycommand.h @@ -27,6 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Summary.single"; } + string getDescription() { return "generate summary file that has the calculator value for each line in the OTU data"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/summarysharedcommand.h b/summarysharedcommand.h index a66027a..f366d0f 100644 --- a/summarysharedcommand.h +++ b/summarysharedcommand.h @@ -28,7 +28,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Summary.shared"; } - + string getDescription() { return "generate a summary file containing calculator values for each line in the OTU data and for all possible comparisons between groups"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/systemcommand.h b/systemcommand.h index 3c22773..e0061f5 100644 --- a/systemcommand.h +++ b/systemcommand.h @@ -26,7 +26,8 @@ class SystemCommand : public Command { string getCommandCategory() { return "General"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/System"; } - + string getDescription() { return "excute system commands from within mothur"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/treegroupscommand.h b/treegroupscommand.h index a52d3b1..d2d6c72 100644 --- a/treegroupscommand.h +++ b/treegroupscommand.h @@ -41,6 +41,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Tree.shared"; } + string getDescription() { return "generate a tree file that describes the dissimilarity among groups"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/trimflowscommand.h b/trimflowscommand.h index 3398458..5affc3f 100644 --- a/trimflowscommand.h +++ b/trimflowscommand.h @@ -27,6 +27,8 @@ public: string getCommandCategory() { return "Hidden"; } string getHelpString(); string getCitation() { return "no citation"; } + string getDescription() { return "trim.flows"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/trimseqscommand.h b/trimseqscommand.h index 40c221a..02a88e8 100644 --- a/trimseqscommand.h +++ b/trimseqscommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "Sequence Processing"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Trim.seqs"; } - + string getDescription() { return "provides the preprocessing features needed to screen and sort pyrosequences"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/unifracunweightedcommand.h b/unifracunweightedcommand.h index 415279c..cd8d51d 100644 --- a/unifracunweightedcommand.h +++ b/unifracunweightedcommand.h @@ -29,7 +29,8 @@ class UnifracUnweightedCommand : public Command { string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Lozupone C, Knight R (2005). UniFrac: a new phylogenetic method for comparing microbial communities. Appl Environ Microbiol 71: 8228-35. \nhttp://www.mothur.org/wiki/Unifrac.unweighted"; } - + string getDescription() { return "generic tests that describes whether two or more communities have the same structure"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/unifracweightedcommand.h b/unifracweightedcommand.h index fe5d76c..b1db317 100644 --- a/unifracweightedcommand.h +++ b/unifracweightedcommand.h @@ -30,7 +30,8 @@ class UnifracWeightedCommand : public Command { string getCommandCategory() { return "Hypothesis Testing"; } string getHelpString(); string getCitation() { return "Lozupone CA, Hamady M, Kelley ST, Knight R (2007). Quantitative and qualitative beta diversity measures lead to different insights into factors that structure microbial communities. Appl Environ Microbiol 73: 1576-85. \nhttp://www.mothur.org/wiki/Unifrac.weighted"; } - + string getDescription() { return "generic tests that describes whether two or more communities have the same structure"; } + int execute(); void help() { m->mothurOut(getHelpString()); } diff --git a/venncommand.h b/venncommand.h index 47f5201..8d14262 100644 --- a/venncommand.h +++ b/venncommand.h @@ -27,7 +27,8 @@ public: string getCommandCategory() { return "OTU-Based Approaches"; } string getHelpString(); string getCitation() { return "http://www.mothur.org/wiki/Venn"; } - + string getDescription() { return "generates a Venn diagram from data provided in a shared file"; } + int execute(); void help() { m->mothurOut(getHelpString()); } -- 2.39.2