annotate qiime2/qiime_gneiss_ilr-hierarchical.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_gneiss_ilr-hierarchical" name="qiime gneiss ilr-hierarchical"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Isometric Log-ratio Transform applied to a hierarchical clustering</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime gneiss ilr-hierarchical
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --i-tree=$itree
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-pseudocount=$ppseudocount
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --o-balances=obalances
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 cp obalances.qza $obalances
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | Composition] The feature table containing the samples in which the ilr transform will be performed. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 <param format="qza,no_unzip.zip" label="--i-tree: ARTIFACT A hierarchy of feature identifiers that defines the Hierarchy partitions of features. Each tip in the hierarchycorresponds to the feature identifiers in the table. This tree can contain tip ids that are not present in the table, but all feature ids in the table must be present in this tree. This assumes that all of the internal nodes in the tree have labels. [required]" name="itree" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 <param label="--p-pseudocount: NUMBER The value to add to zero counts in the feature table. [default: 0.5]" name="ppseudocount" optional="True" type="float" value="0.5" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 <data format="qza" label="${tool.name} on ${on_string}: balances.qza" name="obalances" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 Isometric Log-ratio Transform applied to a hierarchical clustering
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 Calculate balances given a hierarchy.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 table : FeatureTable[Frequency | Composition]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 The feature table containing the samples in which the ilr transform
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 will be performed.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 tree : Hierarchy
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 A hierarchy of feature identifiers that defines the partitions of
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 features. Each tip in the hierarchycorresponds to the feature
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 identifiers in the table. This tree can contain tip ids that are not
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 present in the table, but all feature ids in the table must be present
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 in this tree. This assumes that all of the internal nodes in the tree
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 have labels.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 pseudocount : Float, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 The value to add to zero counts in the feature table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 balances : FeatureTable[Balance]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 The resulting balances from the ilr transform.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 </tool>