annotate qiime2-2020.8/qiime_diversity_alpha-phylogenetic.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_alpha-phylogenetic" name="qiime diversity alpha-phylogenetic"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Alpha diversity (phylogenetic)</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity alpha-phylogenetic
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 --i-phylogeny=$iphylogeny
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 --p-metric=$pmetric
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 --o-alpha-diversity=oalphadiversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24 cp oalphadiversity.qza $oalphadiversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency | PresenceAbsence] The feature table containing the samples for which alpha diversity should be computed. [required]" name="itable" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 <param format="qza,no_unzip.zip" label="--i-phylogeny: ARTIFACT Phylogenetic tree containing tip identifiers that Phylogeny[Rooted] correspond 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. [required]" name="iphylogeny" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
30 <param label="--p-metric: " name="pmetric" optional="False" type="select">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31 <option value="faith_pd">faith_pd</option>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 </param>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 <data format="qza" label="${tool.name} on ${on_string}: alphadiversity.qza" name="oalphadiversity" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 Alpha diversity (phylogenetic)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 Computes a user-specified phylogenetic alpha diversity metric for all
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 samples in a feature table.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 The feature table containing the samples for which alpha diversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 should be computed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 phylogeny : Phylogeny[Rooted]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 Phylogenetic tree containing tip identifiers that correspond to the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 feature identifiers in the table. This tree can contain tip ids that
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 are not present in the table, but all feature ids in the table must be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 present in this tree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 metric : Str % Choices('faith_pd')
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 The alpha diversity metric to be computed.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 alpha_diversity : SampleData[AlphaDiversity]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 Vector containing per-sample alpha diversities.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 </tool>