annotate qiime2/qiime_diversity-lib_alpha-passthrough.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents a0a8d77a991c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity-lib_alpha-passthrough" name="qiime diversity-lib alpha-passthrough"
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
4 <description>Alpha Passthrough (non-phylogenetic)</description>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity-lib alpha-passthrough
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
10
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
12
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
13 --p-metric=$pmetric
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
14
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
15 --o-vector=ovector
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
16
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
17 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
18 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
19 #end if
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
20
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
21 ;
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
22 cp ovector.qza $ovector
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
23
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
24 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
25 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
26 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table containing the samples for which a selected metric should be computed. [required]" name="itable" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
27 <param label="--p-metric: " name="pmetric" optional="False" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
28 <option value="gini_index">gini_index</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
29 <option value="simpson_e">simpson_e</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
30 <option value="osd">osd</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
31 <option value="mcintosh_e">mcintosh_e</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
32 <option value="esty_ci">esty_ci</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
33 <option value="berger_parker_d">berger_parker_d</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
34 <option value="robbins">robbins</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
35 <option value="doubles">doubles</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
36 <option value="michaelis_menten_fit">michaelis_menten_fit</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
37 <option value="singles">singles</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
38 <option value="kempton_taylor_q">kempton_taylor_q</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
39 <option value="fisher_alpha">fisher_alpha</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
40 <option value="strong">strong</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
41 <option value="heip_e">heip_e</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
42 <option value="dominance">dominance</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
43 <option value="goods_coverage">goods_coverage</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
44 <option value="ace">ace</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
45 <option value="enspie">enspie</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
46 <option value="mcintosh_d">mcintosh_d</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
47 <option value="chao1_ci">chao1_ci</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
48 <option value="lladser_pe">lladser_pe</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
49 <option value="brillouin_d">brillouin_d</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
50 <option value="menhinick">menhinick</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
51 <option value="simpson">simpson</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
52 <option value="margalef">margalef</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
53 <option value="chao1">chao1</option>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
54 </param>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
56
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
57 </inputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
58
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
59 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
60 <data format="qza" label="${tool.name} on ${on_string}: vector.qza" name="ovector" />
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
61
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
62 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
63
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
64 <help><![CDATA[
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
65 Alpha Passthrough (non-phylogenetic)
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
66 ###############################################################
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
67
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
68 Computes a vector of values (one value for each samples in a feature table)
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
69 using the scikit-bio implementation of the selected alpha diversity metric.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
70
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
71 Parameters
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
72 ----------
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
73 table : FeatureTable[Frequency]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
74 The feature table containing the samples for which a selected metric
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
75 should be computed.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
76 metric : Str % Choices('ace', 'berger_parker_d', 'simpson_e', 'doubles', 'gini_index', 'michaelis_menten_fit', 'chao1_ci', 'dominance', 'robbins', 'lladser_pe', 'brillouin_d', 'goods_coverage', 'mcintosh_e', 'esty_ci', 'chao1', 'margalef', 'heip_e', 'enspie', 'menhinick', 'simpson', 'strong', 'fisher_alpha', 'osd', 'singles', 'kempton_taylor_q', 'mcintosh_d')
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
77 The alpha diversity metric to be computed.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
78
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
79 Returns
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
80 -------
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
81 vector : SampleData[AlphaDiversity]
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
82 Vector containing per-sample values for the chosen metric.
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
83 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
84 <macros>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
85 <import>qiime_citation.xml</import>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
86 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
87 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents:
diff changeset
88 </tool>