annotate qiime2/qiime_diversity_alpha.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents 370e0b6e9826
children f190567fe3f6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_alpha" name="qiime diversity alpha" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Alpha diversity</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime diversity alpha
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --p-metric=$pmetric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --o-alpha-diversity=oalphadiversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 cp oalphadiversity.qza $oalphadiversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table containing the samples for which alpha diversity should be computed. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 <param label="--p-metric: " name="pmetric" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 <option value="menhinick">menhinick</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 <option value="gini_index">gini_index</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 <option value="chao1_ci">chao1_ci</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 <option value="lladser_pe">lladser_pe</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 <option value="observed_otus">observed_otus</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 <option value="lladser_ci">lladser_ci</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 <option value="simpson_e">simpson_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 <option value="shannon">shannon</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 <option value="pielou_e">pielou_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 <option value="heip_e">heip_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 <option value="mcintosh_e">mcintosh_e</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 <option value="osd">osd</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 <option value="fisher_alpha">fisher_alpha</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <option value="goods_coverage">goods_coverage</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <option value="strong">strong</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 <option value="simpson">simpson</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 <option value="dominance">dominance</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <option value="ace">ace</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <option value="brillouin_d">brillouin_d</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <option value="margalef">margalef</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="esty_ci">esty_ci</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="kempton_taylor_q">kempton_taylor_q</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="berger_parker_d">berger_parker_d</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="enspie">enspie</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="doubles">doubles</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="robbins">robbins</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <option value="singles">singles</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <option value="mcintosh_d">mcintosh_d</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="chao1">chao1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="michaelis_menten_fit">michaelis_menten_fit</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <data format="qza" label="${tool.name} on ${on_string}: alphadiversity.qza" name="oalphadiversity"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 Alpha diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 ###############
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 Computes a user-specified alpha diversity metric for all samples in a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 The feature table containing the samples for which alpha diversity
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 should be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 metric : Str % Choices('pielou_e', 'menhinick', 'mcintosh_e', 'doubles', 'chao1_ci', 'kempton_taylor_q', 'enspie', 'heip_e', 'michaelis_menten_fit', 'observed_otus', 'gini_index', 'dominance', 'osd', 'esty_ci', 'ace', 'berger_parker_d', 'lladser_ci', 'simpson_e', 'shannon', 'margalef', 'brillouin_d', 'robbins', 'simpson', 'fisher_alpha', 'singles', 'goods_coverage', 'mcintosh_d', 'chao1', 'lladser_pe', 'strong')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 The alpha diversity metric to be computed.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 alpha_diversity : SampleData[AlphaDiversity]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 Vector containing per-sample alpha diversities.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 </tool>