annotate qiime2-2020.8/qiime_diversity_alpha-phylogenetic.xml @ 0:5c352d975ef7 draft

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