annotate qiime2/qiime_diversity_alpha-phylogenetic.xml @ 14:a0a8d77a991c draft

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