]> git.donarmstrong.com Git - mothur.git/commitdiff
added command descriptions
authorwestcott <westcott>
Mon, 20 Jun 2011 16:37:41 +0000 (16:37 +0000)
committerwestcott <westcott>
Mon, 20 Jun 2011 16:37:41 +0000 (16:37 +0000)
113 files changed:
aligncommand.h
amovacommand.h
anosimcommand.h
binsequencecommand.h
bootstrapsharedcommand.h
catchallcommand.h
chimerabellerophoncommand.h
chimeraccodecommand.h
chimeracheckcommand.h
chimerapintailcommand.h
chimeraslayercommand.h
chimerauchimecommand.h
chopseqscommand.h
classifyotucommand.h
classifyseqscommand.h
clearcutcommand.h
clustercommand.h
clusterdoturcommand.h
clusterfragmentscommand.h
clustersplitcommand.h
collectcommand.h
collectsharedcommand.h
command.hpp
consensuscommand.h
consensusseqscommand.h
corraxescommand.h
countseqscommand.h
deconvolutecommand.h
degapseqscommand.h
deuniqueseqscommand.h
deuniquetreecommand.h
distancecommand.h
filterseqscommand.h
getcommandinfocommand.cpp
getcommandinfocommand.h
getcurrentcommand.h
getgroupcommand.h
getgroupscommand.h
getlabelcommand.h
getlineagecommand.h
getlistcountcommand.h
getoturepcommand.h
getotuscommand.h
getrabundcommand.h
getrelabundcommand.h
getsabundcommand.h
getseqscommand.h
getsharedotucommand.h
hclustercommand.h
heatmapcommand.h
heatmapsimcommand.h
helpcommand.h
homovacommand.h
indicatorcommand.h
libshuffcommand.h
listseqscommand.h
makefastqcommand.h
makegroupcommand.h
mantelcommand.h
matrixoutputcommand.h
mergefilecommand.h
mergegroupscommand.h
metastatscommand.h
mgclustercommand.h
nmdscommand.h
nocommands.h
normalizesharedcommand.h
otuhierarchycommand.h
pairwiseseqscommand.h
parsefastaqcommand.h
parselistscommand.h
parsimonycommand.h
pcacommand.h
pcoacommand.h
phylodiversitycommand.h
phylotypecommand.h
pipelinepdscommand.h
preclustercommand.h
quitcommand.h
rarefactcommand.h
rarefactsharedcommand.h
readdistcommand.h
readotucommand.h
readtreecommand.h
removegroupscommand.h
removelineagecommand.h
removeotuscommand.h
removerarecommand.h
removeseqscommand.h
reversecommand.h
screenseqscommand.h
secondarystructurecommand.h
sensspeccommand.h
seqerrorcommand.h
seqsummarycommand.h
setcurrentcommand.h
setdircommand.h
setlogfilecommand.h
sffinfocommand.h
sharedcommand.h
shhhercommand.h
splitabundcommand.h
splitgroupscommand.h
subsamplecommand.h
summarycommand.h
summarysharedcommand.h
systemcommand.h
treegroupscommand.h
trimflowscommand.h
trimseqscommand.h
unifracunweightedcommand.h
unifracweightedcommand.h
venncommand.h

index c0147512df11740241e9d4bd611a34b37a2d00b8..952b9364dda6fe79e162e6577fb2d7c0e251c5b4 100644 (file)
@@ -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()); }  
index e9ae48176a782d40ee0eb776a9becb3d7ad2f9ad..89720d6b93c6232a14562cd3c216855fed9a1d8d 100644 (file)
@@ -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()); }
index 593033d2fb086d9a3157ea4a27f1eae4e278e72e..9f8617acf5f087c38864d431786d9e3f2a4ba554 100644 (file)
@@ -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()); }
index 7456a2628f42969f66422d3e194b20508276dcea..365fb3c3afdaf8cedd788b83e1ef2a29a4e9b00b 100644 (file)
@@ -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()); }          
index 78b5c310f21dc75504e491327ef6f0e5dc4e5eb1..d5b48e8129ad2ebdacc5acff8f36bd82b92bea3b 100644 (file)
@@ -32,6 +32,7 @@ public:
        string getCommandCategory()             { return "Hidden";                              }
        string getHelpString(); 
        string getCitation() { return "no citation"; }
+       string getDescription()         { return "bootstrap.shared"; }
 
        
        int execute(); 
index d32989bea50e014c800b84c0de35e72b6e5c859b..238dfb608bb412a311f184d8df2f5dd4d4db9ab9 100644 (file)
@@ -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()); }  
        
index ce85b777eee7a1c24fba9d607b15a9d36c8dc7db..b759d5a99dd8f1864506e3dd81eac46bedab235e 100644 (file)
@@ -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()); }  
index 36584e091537138c8d1ab853ee99be68cbc5bcec..2bf7a70fd159a93fcc813c3236aed97a8c18c916 100644 (file)
@@ -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()); }  
index 9238871de8d8564bb375087800f00c06591698cb..d29744ba39ba1791e27c306c7fd09f950ac15c0f 100644 (file)
@@ -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()); }  
        
index 8dec0ac7d1ec75c4f58e1aa87d03a93bd0861aa8..acb078173501a7d7cf48cc88f5c305e12eccc225 100644 (file)
@@ -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:
index 90f6b62f83fea0bc4abc980baacccb362e216554..35ff7627552d2e2d15fe4e03adcd9c634e8b8b3c 100644 (file)
@@ -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()); }          
index a7d5ad60435f753d088b441aa5b509bce1999808..7af965b8c086a5a5b036d856d91d90350ca54cfe 100644 (file)
@@ -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()); }          
index 31b495b20a7305d2552a770b67f9f2f812a90b1a..e73714d2e98406da2a05e54bb34f61398bd0143c 100644 (file)
@@ -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()); }          
        
index f6bf78dfacb99509ada0d5a87d948f9ffe3aacb2..b3ca6530e3e5e577f8608349bb809739d749c2b1 100644 (file)
@@ -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()); }  
index f075b41495afc9002e2a695d47972d4d947eafc9..9c8dbcac9caf436fcf44b2c416a9e063509561aa 100644 (file)
@@ -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()); }  
index ee64724cc16d711a32238113a66840bd7a4954d0..942953f71bef907980d93355c5a1070599383f61 100644 (file)
@@ -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()); }  
index 3dd4410b6a6a7f5aec286adf2f36338c8b198fad..268ec315a81e1bbbcbd80051986703f3e02f03d4 100644 (file)
@@ -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()); }  
index 42be4a6d659e6b290ccdd37d3be964ad49797df4..3a3234933e65c885c89490738db9e85e6b95d5e3 100644 (file)
@@ -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()); }  
index 2b0294782550a1da8885bbcd73aa10a046b7376b..c7ea7e0d078f0abfe404afd41cab0b4500bc5c48 100644 (file)
@@ -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()); }  
index c1152830ecc96b6211ea6a1842841fafa411a0c5..c4b236cb12dbfc535c1de5da7840b39f21176fb7 100644 (file)
@@ -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()); }  
index 9e513989fd7afea15967ae029d6c48565ba6c299..b882013942e0555be7897a3278b5ccbcb6a20c62 100644 (file)
@@ -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()); }  
index 3eb56fefeaa9e8d26df18df66941d33f8e12a8d3..71c11d62666149a57f88703b253b55c774cb3e70 100644 (file)
@@ -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()); }  
        
index a0bb0017131eaa95f787c3d3ada91f25e3a95c5d..04285feff832088547c64a0f43da9c70dd7b1db5 100644 (file)
@@ -30,6 +30,7 @@ class Command {
                virtual string getCommandCategory() = 0;
                virtual string getHelpString() = 0;
                virtual string getCitation() = 0;
+               virtual string getDescription() = 0;
                
                virtual map<string, vector<string> > getOutputFiles() { return outputTypes; }
                virtual vector<string> setParameters() = 0; //to fill parameters
index fdad93a5efa8a9aee8493d32c37f016bdc21f4f0..a9878517db3b6a1e1bc86d057f1ce5d6a2554b82 100644 (file)
@@ -22,11 +22,12 @@ public:
        ~ConcensusCommand() {}
        
        vector<string> 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()); }  
        
index fd2f4f535dfa3ca7b4be2c99b2e323a2d4d0b49c..6542b708ccf016f52c5864c7581489a8898c6bcd 100644 (file)
@@ -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()); }  
index 45b6989406fc8f5610315dbe0adb511ca4c2349b..2aa7ae0d345cff024b7485ad856013f88895edd9 100644 (file)
@@ -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()); }  
index 385cd13536e0ed395bed74d875e620bc131e87c4..89549a9ac0b0c74e6cdd18372ac4cdb834b5e8be 100644 (file)
@@ -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()); }  
        
index 21a008190fdc168a9259c1abe4f8461c99fc87cd..487c4601780a209418be72b8eb8c04edd0a55442 100644 (file)
@@ -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()); }  
index 0bf0a5759ec163cc1b0f87fd693913cd02a8a127..342cd366cd53ce4b8300e2f7d5cd748b04a21668 100644 (file)
@@ -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()); }  
        
index a8edea2fab447cea46b5a2aa0bcd69fbdec27f0d..300a1caeab4ce8b6b2febb10b6082c857fcfeb93 100644 (file)
@@ -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()); }  
index 5131c114986e67c70c43019c44f67830c5ce1e4b..6d72253bad9b1556aed865cae0a1e8b52c91cdea 100644 (file)
@@ -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()); }
index 81267d1604ca2ba2a4551b2520cc6eeee7182a0f..bac5d14946a591a3a3990637dcf21f492c027ae3 100644 (file)
@@ -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()); }  
        
index 809c6eb69b427f8466cb97d60322e7a27b6d53ed..e445023df07f7c0c6e3bcc6c4d0e95c574e6174d 100644 (file)
@@ -26,6 +26,7 @@ public:
        string getCommandCategory()             { return "Sequence Processing"; }\r
        string getHelpString(); \r
        string getCitation() { return "http://www.mothur.org/wiki/Filter.seqs"; }\r
+       string getDescription()         { return "removes columns from alignments based on a criteria defined by the user"; }\r
        \r
        int execute(); \r
        void help() { m->mothurOut(getHelpString()); }  \r
index 52559b3c064f6437affcbdc5dcd3d0b174089b42..ad706ef6bedeacf414ac9bbe3ad7119735b514d2 100644 (file)
@@ -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<string, vector<string> > thisOutputTypes = thisCommand->getOutputFiles();
                                map<string, vector<string> >::iterator itTypes;
index c67a4eded0536e11177cd3db392efe2fa3ae7364..463c94c41f62d994b0e462cc3c745ac73b733ad0 100644 (file)
@@ -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()); }  
index bfa9168dcd81347afe271062f224763fdcb56ce1..dfff0fa27d09573ab35d95ddb8c1375f77d9ac5e 100644 (file)
@@ -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()); }  
index a539834177b63a51929d52299c68779a27046fba..a3e47e0204e36bfa54970c1d5c0e3ecb9398ab90 100644 (file)
@@ -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()); }  
index fda603c1fd46323a3af168cd7ba32777a1fbf5a9..642107dafc9d567aa93270195740030d33698e52 100644 (file)
@@ -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()); }  
index 71645704592d6bebdc4cca894d43d3b13732fed8..c5dc1a119969e3ac10b0462c4ad5090bee1333f3 100644 (file)
@@ -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()); }  
index ca84bf2fad3e11e60808daa15230b5674a4a7849..4c9514d2226028f54d6996070d3776d66aab6122 100644 (file)
@@ -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()); }  
index a0b5f092247cc6c1a702fb47afc7c2b499542efb..7a0c1098f331beffdf06829f7c804032f45a8d8b 100644 (file)
@@ -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(); 
index 179a1b3becb27091fbe5fc6e78d1b1f91a70e10d..07cccde36aaae2e7c0f8f3687901caaa02557974 100644 (file)
@@ -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()); }  
index 30f4f3cb0b18aedb2a28348f41f720e967ea1d01..1a784935c476c22c798f8dfda33008606cc43439 100644 (file)
@@ -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()); }  
index 81a5d910b53c84db70c560255ce2b508c4361f33..cb9e270d170e0ab9dde910fdb7d24ef6c293828f 100644 (file)
@@ -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()); }  
index 0df0e7d981f27b638c4bfd09d745ca9cbc9481bc..1d5163d2bf662566f2ad5923980dfc96f081231f 100644 (file)
@@ -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()); }  
index da998f563ba4f9b5a1726f821a8e96dfbfa6209a..5be00df16ebffdb079273befc3f1d03324256c88 100644 (file)
@@ -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()); }  
        
index 4fef8e795be355d23d1348f2ed323e225092b0f9..4561d28614c62686c42e29a9747b84d853537fd0 100644 (file)
@@ -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()); }  
        
index d7ffef3c74b965967dd6f68d7a6914183ec2253f..ea6ed94ee687004d88a04e140f187392b05f5b42 100644 (file)
@@ -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()); }  
        
index adf9f25f3bc92f4f67e15a6e84c210637de7b2ef..aeeb3bc9cb295d93bbec1c33f405dcab27e55673 100644 (file)
@@ -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()); }  
        
index 3bb979108948ac712b4758296b34ed3aba8e7c52..ccd5f4868e9061ed61e4a90ae042ae6bded4fa68 100644 (file)
@@ -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()); }  
index ba5a240c8ade230de7433413cefe1dcfdf930402..dd6fa2c87bdb2dc79a4ab8b7245143d04925b26d 100644 (file)
@@ -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()); }  
        
index c542899fce02b3d9781f553d55054e876bb3b94e..cba07087148b0a537a299746c808f4314ea05806 100644 (file)
@@ -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()); }  
        
index d9daa0e2857f3090d8100a01fd57b8e2d72d69e7..4afaeb8e3120b42558f5e555c9237474b27a510e 100644 (file)
@@ -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()); }  
        
index 578aa95cbd6ebd773e6595c875ef487fe4a6861b..00694bea297688fc57804fc4ab41b61287e798d0 100644 (file)
@@ -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()); }  
        
index 96e68f39b7caee9f369a2068ac6e7519cadfef45..465a67f02d2858b86e8f79761c7f141813be185c 100644 (file)
@@ -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()); }  
        
index ea48430e9e0876c1034c344d5688fd64bc0c2bde..f814d8487d81fc98e98f2245ee13c5564ec5424b 100644 (file)
@@ -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()); }  
        
index 085654fc28900a871e83a61dffdc26b4f8300bfc..1c209aab392f82a06ec5bce2d92811e20286df69 100644 (file)
@@ -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()); }  
index f5fb3583f13b09b4f4cc4f70709eca3ffeec388e..e0c709204a6be01c637bf3ada3fbdb73a8c7b3d8 100644 (file)
@@ -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()); }  
        
index 5b2fe6f347b5090991b7f1c83cb5a534e6c0c7f1..adffda857c4e4aa64ceb38c502f011d7ecefed2e 100644 (file)
@@ -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()); }
        
index b42cfb92c62a74fdb55b7902c3bfa9644c7359f7..ae38b46c5c1d60a1c6c97b5a618f1eca8d59a417 100644 (file)
@@ -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()); }  
index 1e56f73a865079f7dca0ccab91f3fd6f0ddfcbef..1c3c4d5a5ea12a6bcbc9cae3cd9eca54b3bd083d 100644 (file)
@@ -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()); }  
index dfd65adf1fdc9f7c6c84491f0714eff5cfd3888c..7907dfe85f556682d1cc796323314a2f0c8d7b67 100644 (file)
@@ -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()); }  
index 04c344375b65d33796d2544eff9dd1c2b61fda07..88e32acc0426a15525b1278bd5fc6d9c4d6392fc 100644 (file)
@@ -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()); }  
        
index 6ad1855ad007a36907e0c63d89b8d3d249ee2939..df0c526f2071636e87b0c2a403d2410324a8b89d 100644 (file)
@@ -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()); }  
        
index 0b7f5a8264c18b88ca0a271089e818cd85bfd86b..c05c9fe36cfd1d2ecbf545451d753fe25b946968 100644 (file)
@@ -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()); }
        
index b7fa6f19fb10d4178d826158a4b19606c81a0e8b..5ed7e127d09ce645aa11cd43dd2192a1155b42dc 100644 (file)
@@ -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()); }  
index 6332fd7fe1f36f19cd232cde99d9c6629fc00ca5..c25274119ac3c918dcfa8ef584b05bd3f9310bc9 100644 (file)
@@ -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()); }  
index 342b5aa52804dda54bea8da6e8c1b4276d089290..8a2c862cb66398ec1c00e964c627d158fc0d39c0 100644 (file)
@@ -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()); }  
index cbd5aa402e7c61d624671590313bb32cb974dc11..afb8e19dc476050139de07964c7697626fef3fd7 100644 (file)
@@ -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()); }  
        
index dfafca6fee21c9f5493437fe37007669c3fc4ac7..60524566b2a4f02e4571c38d0602980e676d8138 100644 (file)
@@ -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()); }          
index 9489b9b29108ed13969352c6ed1fe3a994e7f326..9356299b91c45c82b073c424a81b9a6bb28673e8 100644 (file)
@@ -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()); }  
index 5e5484f4687474886730e437ea3d44d6aced3ccb..81fa99ba06c691f9e0ee06f4b73521655b046e8c 100644 (file)
@@ -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()); }
        
index f139214d6b1c0e0ac526e3df484b0168674a3f05..d16e896dac848552885bd9b9c33321f5be463c9b 100644 (file)
@@ -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()); }  
        
index 5b84d48cfa913f8b640646c272c1c90ec340bd58..3d24f6a97f799f1c8627ef40d5dbec888da51dc6 100644 (file)
@@ -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()); }
        
index 52295cf65250846036ac07fdd687832c30ef5e10..b44e6caed27037ddb177acdd1416df40550dee5c 100644 (file)
@@ -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:
index a0411308e01121af1a56a68dd28218b421598cbc..ecc7376ecb7ea1a312af1e374ae76fb089e08add 100644 (file)
@@ -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()); }
        
index c4b4646881f5c1b6bfbd9a682bda765a70c4193f..8abe0ea7a439e99aae5be49dc5734516ce9bdab1 100644 (file)
@@ -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()); }  
index 8302fedc78717b73a642d28f08d8a173ad2fc77b..3a12413d6f055d0c4f12e0291a442ed4dcc8fb63 100644 (file)
@@ -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()); }  
index f1929bf3b861926a893615f12a8e36c8e8f326d8..64958008deae4165e4a9019ddf93a0f44fd09f25 100644 (file)
@@ -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()); }  
        
index 0bf8a4528025eafc3f0e16955e08fbf4553ea13b..b4bce3e172d141ab5e1fdcea1c59bd35b25dadab 100644 (file)
@@ -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()); }  
        
index 7d4dc5edb76222095d0d650b93476e3218417044..2112e8d78565712a490de69bedd2ffb44844a768 100644 (file)
@@ -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()); }  
        
index eaa4484bc6c9e2fd90acf8b50c2c17b2675aabef..afe077d4e0e16c7763dc8304130242d2e0af1d4e 100644 (file)
@@ -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()); }  
        
index 0f6644bdb4b8b0126f5ace2b5f11f9e505f44094..c6d65037516c495f391ceb983273b1b9a20010e1 100644 (file)
@@ -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()); }  
index 70d3c6e27d8cdd135483e7f4c3c1e5ee57df067c..cbf376909ff998531ed959f34edb5d72e8b72fcd 100644 (file)
@@ -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()); }  
index ce352ca58c93e1b73adeee2c384418dd877af895..daf2066feade74af3239e12f3a48a7b314de0a4c 100644 (file)
@@ -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()); }  
index 310a66a5a90ea24acf34d7a94d8f7ff7df5a154d..bda398b76b7cf8b0b2bf86c618e8adff71a1ff3a 100644 (file)
@@ -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()); }  
        
index cb017b450e78123ea2cd32bbbf93675cd1bc15b5..6a7cf8a1e55fa1a5fe5915b4cb6da1c3150729ef 100644 (file)
@@ -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()); }  
        
index 2ab1272efbef88fdb008f903cf02a7d66ed3215a..9e58c064f1c8e0c1bf5a4356c028ba9a60afed80 100644 (file)
@@ -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()); }  
index b89a509c5f76971d9df9de9a3fd4e9113a70b816..df96e4514bc84787ad901e137bbc794588681705 100644 (file)
@@ -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()); }  
        
index 2e4719a52ada1949236bca5f42d450e7f2eb168d..f0fdfa887890607ea3efa2ccfdc44c7b95c1b7c7 100644 (file)
@@ -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()); }  
index b165bba2f2f343a8a20a4b07cb2290a43fd13c32..3642295b54af9d46fd246ad642065952af7295ab 100644 (file)
@@ -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()); }  
        
index daee85a37fd4e13df952ea363da36227dde85143..4e7bdea09cac0d1bd86d780eb92e499bbe9bfc69 100644 (file)
@@ -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()); }  
index 47d6e4e5fedfd92ec15700b931ce06681e5daf2c..1631e74ae054c834b30ed6763ad73faff10b0a13 100644 (file)
@@ -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()); }  
        
index 3fdd66930a3078114b28d6f2f126de3da70f7da5..e467df11c99d735a482328c7dbe64aa623192a95 100644 (file)
@@ -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()); }  
index 4bf6759dcda1d4eccda99658780a1e9d819bcece..c0d368770cfa8df11560d2b89fee200231cb0dc3 100644 (file)
@@ -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()); }          
index e942e60b436acbd5ad9a014ddc8176c899e14806..0033ed58cf25a274e9e4bbe2a17aa4e4cb298ef0 100644 (file)
@@ -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()); }  
        
index 625c83b63d40c6674490fe00b510cd2780449d08..b3b00c46c65b65f1c7f243221ceb4e814a37dbc5 100644 (file)
@@ -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()); }  
        
index d187c0732cf6dfc676fcdc6ba6b4d57cef0c6dae..8d3bfcdc15d3c75253a78abe12b3277c1f9b6c8b 100644 (file)
@@ -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()); }  
        
index abfaa4b8a088713278a9384c08909f9eaaad70d2..f18a3f5568167c031adabd5607cf2c07c2f651f9 100644 (file)
@@ -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()); }  
        
index add6ee8d4a6ebdfd86d6a08d750c7fe88cc3bd35..51a25281cfea1e6a47d9bfc969bb63eccc9624e9 100644 (file)
@@ -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()); }  
        
index a95815fd154be1027d79cb33861c733be207ef1d..bdc850362b4b08e6c2e14655360e455353e74793 100644 (file)
@@ -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()); }          
index 444b55edf9fb7d5f3f126e3f96a3214aa6a167dc..df925f34cc70bc405ac35e2302ecc49a8fd97872 100644 (file)
@@ -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()); }  
index a9a6343084c0982b1be2c6a8688a60cb45804375..f8bdca17e2a06877a81d4d5eca2fcabd64cef52a 100644 (file)
@@ -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()); }  
index 5656dab49e7ac7d58665369e58c1950c17b93542..39d3c375268b4712cdb5cc2297179ca5dff27978 100644 (file)
@@ -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()); }  
        
index e79f3e103bb0cd8295aad188950db2d527cf23a2..15b7f4066e9f17b263b30ac3d0b663d7cd414455 100644 (file)
@@ -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()); }  
index a66027ac8c408685563314f548ae540c87de01c6..f366d0f62432e0bc34c475b190f946a04ba26335 100644 (file)
@@ -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()); }  
        
index 3c22773f2d9e70417c6dc3fef6a58181a16440f0..e0061f587ea6a3c7003fbc8b16a48763242ce964 100644 (file)
@@ -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()); }  
        
index a52d3b189354f910c3b92cf65a24aeac4a137c68..d2d6c721c72fcc5d96926fc246c31e89743dca58 100644 (file)
@@ -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()); }  
index 339845883f2b1c088d7d21eee05ee81c0d618d08..5affc3fbdf7fedc366f7c8294c762e28681d7625 100644 (file)
@@ -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()); }  
index 40c221a0ec61c051099d081f15dd87bea135a163..02a88e889654fd2c6d805e64fbd576a3e1ceb5ad 100644 (file)
@@ -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()); }  
        
index 415279c9b2adad30f95a11eeef309d9d3fd3b802..cd8d51dcad76a44dbc0ca064bd79a5ef3e0fbe80 100644 (file)
@@ -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()); }
        
index fe5d76c700a130848c9f5f3eef657a3094cda177..b1db317de0add4b28352315e20dc282110fad789 100644 (file)
@@ -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()); }
        
index 47f52015674aa52cd3f137b49d203e78ff1ae70d..8d142623621bea33cc6f06d907e6b4fa2a667e2f 100644 (file)
@@ -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()); }