annotate collectorcurve/collectorcurve.xml @ 0:f4d86766f766 draft

Uploaded
author qfab
date Fri, 30 May 2014 03:16:03 -0400
parents
children 03ab673e45cb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f4d86766f766 Uploaded
qfab
parents:
diff changeset
1 <tool id="mothur_collect_single" name="Collector Curve" version="1.0" force_history_refresh="True">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
2 <description>Calculate and plot collector's curves for OTUs</description>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
3 <requirements>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
4 <requirement type="binary">@BINARY@</requirement>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
5 <requirement type="package" version="1.30.2-1.33.3">mothur</requirement>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
6 </requirements>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
7 <command interpreter="bash">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
8 collectorcurve.sh
f4d86766f766 Uploaded
qfab
parents:
diff changeset
9 #if isinstance($otu.datatype, $__app__.datatypes_registry.get_datatype_by_extension('shared').__class__):
f4d86766f766 Uploaded
qfab
parents:
diff changeset
10 shared
f4d86766f766 Uploaded
qfab
parents:
diff changeset
11 #elif isinstance($otu.datatype, $__app__.datatypes_registry.get_datatype_by_extension('rabund').__class__):
f4d86766f766 Uploaded
qfab
parents:
diff changeset
12 rabund
f4d86766f766 Uploaded
qfab
parents:
diff changeset
13 #elif isinstance($otu.datatype, $__app__.datatypes_registry.get_datatype_by_extension('sabund').__class__):
f4d86766f766 Uploaded
qfab
parents:
diff changeset
14 sabund
f4d86766f766 Uploaded
qfab
parents:
diff changeset
15 #elif isinstance($otu.datatype, $__app__.datatypes_registry.get_datatype_by_extension('list').__class__):
f4d86766f766 Uploaded
qfab
parents:
diff changeset
16 list
f4d86766f766 Uploaded
qfab
parents:
diff changeset
17 #end if
f4d86766f766 Uploaded
qfab
parents:
diff changeset
18 $otu
f4d86766f766 Uploaded
qfab
parents:
diff changeset
19 $label
f4d86766f766 Uploaded
qfab
parents:
diff changeset
20 $output
f4d86766f766 Uploaded
qfab
parents:
diff changeset
21 $output.id
f4d86766f766 Uploaded
qfab
parents:
diff changeset
22 $__new_file_path__
f4d86766f766 Uploaded
qfab
parents:
diff changeset
23 #if $calc.__str__ != "None" and len($calc.__str__) > 0:
f4d86766f766 Uploaded
qfab
parents:
diff changeset
24 $calc
f4d86766f766 Uploaded
qfab
parents:
diff changeset
25 #end if
f4d86766f766 Uploaded
qfab
parents:
diff changeset
26 $advancedoption.advanced
f4d86766f766 Uploaded
qfab
parents:
diff changeset
27 #if $advancedoption.advanced:
f4d86766f766 Uploaded
qfab
parents:
diff changeset
28 $advancedoption.abundoption.cabund
f4d86766f766 Uploaded
qfab
parents:
diff changeset
29 #if $advancedoption.abundoption.cabund:
f4d86766f766 Uploaded
qfab
parents:
diff changeset
30 $advancedoption.abundoption.abund
f4d86766f766 Uploaded
qfab
parents:
diff changeset
31 #else
f4d86766f766 Uploaded
qfab
parents:
diff changeset
32 ''
f4d86766f766 Uploaded
qfab
parents:
diff changeset
33 #end if
f4d86766f766 Uploaded
qfab
parents:
diff changeset
34 $advancedoption.sizeoption.csize
f4d86766f766 Uploaded
qfab
parents:
diff changeset
35 #if $advancedoption.sizeoption.csize:
f4d86766f766 Uploaded
qfab
parents:
diff changeset
36 $advancedoption.sizeoption.size
f4d86766f766 Uploaded
qfab
parents:
diff changeset
37 #else
f4d86766f766 Uploaded
qfab
parents:
diff changeset
38 ''
f4d86766f766 Uploaded
qfab
parents:
diff changeset
39 #end if
f4d86766f766 Uploaded
qfab
parents:
diff changeset
40 $advancedoption.freqoption.cfreq
f4d86766f766 Uploaded
qfab
parents:
diff changeset
41 #if $advancedoption.freqoption.cfreq:
f4d86766f766 Uploaded
qfab
parents:
diff changeset
42 $advancedoption.freqoption.freq
f4d86766f766 Uploaded
qfab
parents:
diff changeset
43 #else
f4d86766f766 Uploaded
qfab
parents:
diff changeset
44 ''
f4d86766f766 Uploaded
qfab
parents:
diff changeset
45 #end if
f4d86766f766 Uploaded
qfab
parents:
diff changeset
46 #end if
f4d86766f766 Uploaded
qfab
parents:
diff changeset
47 </command>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
48 <inputs>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
49 <param name="otu" type="data" format="rabund,sabund,list,shared" label="OTU list (rabund, sabund, list or shared format)" help="The rabund output from the 'Map Reads to OTU' tool"/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
50 <param name="label" type="select" label="Labels - OTU labels" multiple="true" help="Select one or more labels to calculate the collector's curve for. By default all labels are selected" >
f4d86766f766 Uploaded
qfab
parents:
diff changeset
51 <options>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
52 <filter type="data_meta" ref="otu" key="labels" />
f4d86766f766 Uploaded
qfab
parents:
diff changeset
53 </options>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
54 </param>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
55 <param name="calc" type="select" label="Calculators" multiple="true" help="Select one or more calculators for collector's curve generation. By default chao, invsimpson and npshannon are selected. Please see the description for information on the calculators.">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
56 <option value="ace">ace</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
57 <option value="bootstrap">bootstrap</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
58 <option value="chao" selected="true">chao</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
59 <option value="jack">jack</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
60 <option value="sobs">sobs</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
61 <option value="simpsoneven">simpsoneven</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
62 <option value="shannoneven">shannoneven</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
63 <option value="heip">heip</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
64 <option value="smithwilson">smithwilson</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
65 <option value="bergerparker">bergerparker</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
66 <option value="coverage">coverage</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
67 <option value="goodscoverage">goodscoverage</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
68 <option value="simpson">simpson</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
69 <option value="invsimpson" selected="true">invsimpson</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
70 <option value="qstat">qstat</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
71 <option value="shannon">shannon</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
72 <option value="npshannon" selected="true">npshannon</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
73 <option value="boneh">boneh</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
74 <option value="efron">efron</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
75 <option value="shen">shen</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
76 <option value="solow">solow</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
77 <option value="logseries">logseries</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
78 <option value="geometric">geometric</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
79 <option value="bstick">bstick</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
80 <option value="nseqs">nseqs</option>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
81 </param>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
82 <conditional name="advancedoption">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
83 <param name="advanced" type="boolean" value="true" label="Please select to show and specify advanced option" help="Advanced options including specification of ACE Estimator threshold for abundant versus rare OTUs, sample size for OTU predicition and frequency for output."/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
84 <when value="true">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
85 <conditional name="abundoption">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
86 <param name="cabund" type="boolean" value="true" label="Select, if you would like to specify the ACE Estimator threshold for abundant versus rare OTUs" help=""/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
87 <when value="true">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
88 <param name="abund" type="integer" value="10" label="Abund - ACE estimator threshold for abundant versus rare OTUs (default 10)"/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
89 </when>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
90 </conditional>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
91 <conditional name="sizeoption">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
92 <param name="csize" type="boolean" value="true" label="Select, if you would like to specify the sample size for OTU prediction" help=""/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
93 <when value="true">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
94 <param name="size" type="integer" value="1" label="Size - sample size for OTU prediction (ignored if &lt; 1)"
f4d86766f766 Uploaded
qfab
parents:
diff changeset
95 help="By default these calculators will base the prediction on a sample that is the same size as the initial sampling"/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
96 </when>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
97 </conditional>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
98 <conditional name="freqoption">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
99 <param name="cfreq" type="boolean" value="true" label="Select, if you would like to specify the frequency for output" help=""/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
100 <when value="true">
f4d86766f766 Uploaded
qfab
parents:
diff changeset
101 <param name="freq" type="float" value="0.1" label="Frequency - frequency for output (the default setting is to output data every 100 sequences)"
f4d86766f766 Uploaded
qfab
parents:
diff changeset
102 help="Use a decimal between 0 and 1 to set the frequency as a percentage of the number of sequences"/>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
103 </when>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
104 </conditional>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
105 </when>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
106 </conditional>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
107 </inputs>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
108 <outputs>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
109 <data format="tabular" name="output" label="${tool.name} on ${on_string}: tab" />
f4d86766f766 Uploaded
qfab
parents:
diff changeset
110 </outputs>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
111 <tests>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
112 <test>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
113 <param name="otu" value="reads2otu.rabund" />
f4d86766f766 Uploaded
qfab
parents:
diff changeset
114 <param name="label" value="0.03" />
f4d86766f766 Uploaded
qfab
parents:
diff changeset
115 <param name="calc" value="chao-invsimpson-npshannon" />
f4d86766f766 Uploaded
qfab
parents:
diff changeset
116 <output name="output" file="collectorsummary.tabular" ftype="tabular" lines_diff="10" />
f4d86766f766 Uploaded
qfab
parents:
diff changeset
117 </test>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
118 </tests>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
119 <help>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
120 ===========
f4d86766f766 Uploaded
qfab
parents:
diff changeset
121 Description
f4d86766f766 Uploaded
qfab
parents:
diff changeset
122 ===========
f4d86766f766 Uploaded
qfab
parents:
diff changeset
123
f4d86766f766 Uploaded
qfab
parents:
diff changeset
124 Collector's curve calculation based on mothur's collect.single command.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
125
f4d86766f766 Uploaded
qfab
parents:
diff changeset
126 Collector's curves can be calculated using calculators, that describe the richness, diversity, and other features of individual samples. Collector's curves describe how richness or diversity change as you sample additional individuals. If a collector's curve becomes parallel to the x-axis, you can be reasonably confident that you have done a good job of sampling and can trust the last value in the curve. Otherwise, you need to keep sampling.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
127 For calculator parameter choices see: mothur_wiki__
f4d86766f766 Uploaded
qfab
parents:
diff changeset
128
f4d86766f766 Uploaded
qfab
parents:
diff changeset
129 .. _mothur_wiki: http://www.mothur.org/wiki/Calculators
f4d86766f766 Uploaded
qfab
parents:
diff changeset
130
f4d86766f766 Uploaded
qfab
parents:
diff changeset
131 -----
f4d86766f766 Uploaded
qfab
parents:
diff changeset
132
f4d86766f766 Uploaded
qfab
parents:
diff changeset
133 ----------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
134 Input
f4d86766f766 Uploaded
qfab
parents:
diff changeset
135 ----------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
136
f4d86766f766 Uploaded
qfab
parents:
diff changeset
137 OTU list
f4d86766f766 Uploaded
qfab
parents:
diff changeset
138 rabund,
f4d86766f766 Uploaded
qfab
parents:
diff changeset
139 sabund,
f4d86766f766 Uploaded
qfab
parents:
diff changeset
140 list or
f4d86766f766 Uploaded
qfab
parents:
diff changeset
141 shared format
f4d86766f766 Uploaded
qfab
parents:
diff changeset
142
f4d86766f766 Uploaded
qfab
parents:
diff changeset
143 ----------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
144 Parameters
f4d86766f766 Uploaded
qfab
parents:
diff changeset
145 ----------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
146
f4d86766f766 Uploaded
qfab
parents:
diff changeset
147 Labels - OTU labels
f4d86766f766 Uploaded
qfab
parents:
diff changeset
148 Select labels you want the collector's curve calculated for (e.g. lines labelled 0.03)
f4d86766f766 Uploaded
qfab
parents:
diff changeset
149 by default collector's curves will be calculated for all labels listed
f4d86766f766 Uploaded
qfab
parents:
diff changeset
150
f4d86766f766 Uploaded
qfab
parents:
diff changeset
151 Calculators
f4d86766f766 Uploaded
qfab
parents:
diff changeset
152 Find following the list of available calculators (see mothur_wiki_ for a more detailed description)
f4d86766f766 Uploaded
qfab
parents:
diff changeset
153 and select calculators for calculating collector's curves .
f4d86766f766 Uploaded
qfab
parents:
diff changeset
154 Default selection: chao - Community richness, npshannon (non-parametric) and invsimpson - Community diversity
f4d86766f766 Uploaded
qfab
parents:
diff changeset
155
f4d86766f766 Uploaded
qfab
parents:
diff changeset
156 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
157 | chao | Community richness the Chao1 estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
158 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
159 | invsimpson | Community diversity the Simpson index |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
160 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
161 | npshannon | Community diversity the non-parametric Shannon index |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
162 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
163 | ace | Community richness the ACE estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
164 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
165 | bootstrap | Community richness the bootstrap estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
166 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
167 | jack | Community richness the jackknife estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
168 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
169 | sobs | Community richness the observed richness |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
170 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
171 | simpsoneven | Community evenness a Simpson index-based measure of evenness |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
172 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
173 | shannoneven | Community evenness a Shannon index-based measure of evenness |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
174 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
175 | heip | Community evenness Heip's metric of community evenness |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
176 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
177 | smithwilson | Community evenness Smith and Wilson's metric of community evenness |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
178 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
179 | bergerparker | Community diversity the Berger-Parker index |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
180 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
181 | coverage | Community diversity the sampling coverage |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
182 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
183 | goodscoverage | Community diversity the Good's estimate of sampling coverage |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
184 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
185 | simpson | Community diversity the Simpson index |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
186 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
187 | qstat | Community diversity the Q statistic |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
188 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
189 | shannon | Community diversity the Shannon index |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
190 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
191 | boneh | Estimator Boneh's estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
192 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
193 | efron | Estimator Efron's estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
194 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
195 | shen | Estimator Shen's estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
196 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
197 | solow | Estimator Solow's estimator |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
198 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
199 | logseries | Statistical distribution tests whether observed data follow the log series distribution |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
200 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
201 | geometric | Statistical distribution tests whether observed data follow the geometric series distribution |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
202 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
203 | bstick | Statistical distribution tests whether observed data follow the broken stick distribution |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
204 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
205 | nseqs | Utility the number of sequences in a sample |
f4d86766f766 Uploaded
qfab
parents:
diff changeset
206 +---------------+-----------------------------------------------------------------------------------------------+
f4d86766f766 Uploaded
qfab
parents:
diff changeset
207
f4d86766f766 Uploaded
qfab
parents:
diff changeset
208
f4d86766f766 Uploaded
qfab
parents:
diff changeset
209 ----------------------------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
210 Optional advanced parameters
f4d86766f766 Uploaded
qfab
parents:
diff changeset
211 ----------------------------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
212
f4d86766f766 Uploaded
qfab
parents:
diff changeset
213 ACE estimator threshold
f4d86766f766 Uploaded
qfab
parents:
diff changeset
214 By default the ACE estimator uses 10 as the cutoff between OTUs that are rare and abundant. So if an OTU has more than 10 individuals in it, then it is considered abundant. This is really just an empirical decision and we are merely following the lead of Anne Chao and others who implement 10 in their software. If you would like to use a different cutoff, you can use the abund option.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
215
f4d86766f766 Uploaded
qfab
parents:
diff changeset
216 Size - Sample Size
f4d86766f766 Uploaded
qfab
parents:
diff changeset
217 Within the suite of calculators available in mothur are a set that will predict the number of additional OTUs that will be observed for a given sample size. By default these calculators will base the prediction on a sample that is the same size as the initial sampling. If you would like to use a different sample size, use the size option.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
218 The value of size should be between 1 and the size of the initial sampling.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
219
f4d86766f766 Uploaded
qfab
parents:
diff changeset
220 Frequency
f4d86766f766 Uploaded
qfab
parents:
diff changeset
221 For larger datasets you might not be interested in obtaining all of the data for the number of sequences sampled. For instance, if you have 100,000 sequences, you may only want to output the data every 100 sequences. Alternatively, if you only have 100 sequences, you may only want to output all of the data.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
222 The default setting is to output data every 100 sequences.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
223
f4d86766f766 Uploaded
qfab
parents:
diff changeset
224 ------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
225 Output
f4d86766f766 Uploaded
qfab
parents:
diff changeset
226 ------
f4d86766f766 Uploaded
qfab
parents:
diff changeset
227
f4d86766f766 Uploaded
qfab
parents:
diff changeset
228 .. class:: warningmark
f4d86766f766 Uploaded
qfab
parents:
diff changeset
229
f4d86766f766 Uploaded
qfab
parents:
diff changeset
230 Please note, the number of outputs is depending on the number of selected calculators. Each selected calculator will result in an extra output, which is indicated by the calculator name in brackets at the end of the output's filename. In case the outputs for the selected calculators are **not** showing in the History panel, refresh your history by clicking on the refresh icon.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
231
f4d86766f766 Uploaded
qfab
parents:
diff changeset
232
f4d86766f766 Uploaded
qfab
parents:
diff changeset
233 (A) A summary file in table format containing the following fields, number of sequences, the sample coverage, the number of observed OTUs, the chao richness estimate, the invsimpson diversity estimate, and the npshannon non-parametric diversity estimate. The summary gives results for each of the listed fields when all available data is used.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
234
f4d86766f766 Uploaded
qfab
parents:
diff changeset
235 (B) Followed by a file for each calculator selected (indicated by the calculator's name in brackets at the end of the output's filename) which can be plotted as collector's curve and used to evaluate how the results of the calculator change with sampling effort.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
236
f4d86766f766 Uploaded
qfab
parents:
diff changeset
237 .. class:: infomark
f4d86766f766 Uploaded
qfab
parents:
diff changeset
238
f4d86766f766 Uploaded
qfab
parents:
diff changeset
239
f4d86766f766 Uploaded
qfab
parents:
diff changeset
240 Use Galaxy's integrated visualization tool to plot the collector's curve. The visualization tool is accessible via the 'Visualize' icon in the extended dataset information area. After having launched the integrated visualization tool select the 'Data Controls' tab. In the 'Data Controls' tab select column 1 (number sampled) as 'Data column for X' and use column 2 (minimum identity, according to select labels) as 'Data column for Y'.
f4d86766f766 Uploaded
qfab
parents:
diff changeset
241
f4d86766f766 Uploaded
qfab
parents:
diff changeset
242 -----
f4d86766f766 Uploaded
qfab
parents:
diff changeset
243
f4d86766f766 Uploaded
qfab
parents:
diff changeset
244 =========
f4d86766f766 Uploaded
qfab
parents:
diff changeset
245 Resources
f4d86766f766 Uploaded
qfab
parents:
diff changeset
246 =========
f4d86766f766 Uploaded
qfab
parents:
diff changeset
247
f4d86766f766 Uploaded
qfab
parents:
diff changeset
248 mothur_
f4d86766f766 Uploaded
qfab
parents:
diff changeset
249
f4d86766f766 Uploaded
qfab
parents:
diff changeset
250 .. _http://www.mothur.org
f4d86766f766 Uploaded
qfab
parents:
diff changeset
251
f4d86766f766 Uploaded
qfab
parents:
diff changeset
252 **Author**
f4d86766f766 Uploaded
qfab
parents:
diff changeset
253
f4d86766f766 Uploaded
qfab
parents:
diff changeset
254 Patrick D. Schloss (pschloss@umich.edu)
f4d86766f766 Uploaded
qfab
parents:
diff changeset
255
f4d86766f766 Uploaded
qfab
parents:
diff changeset
256 **Wrapper Author**
f4d86766f766 Uploaded
qfab
parents:
diff changeset
257
f4d86766f766 Uploaded
qfab
parents:
diff changeset
258 QFAB Bioinformatics (support@qfab.org)
f4d86766f766 Uploaded
qfab
parents:
diff changeset
259 based on jjohnson mothur_toolsuite wrapper
f4d86766f766 Uploaded
qfab
parents:
diff changeset
260
f4d86766f766 Uploaded
qfab
parents:
diff changeset
261 </help>
f4d86766f766 Uploaded
qfab
parents:
diff changeset
262 </tool>