annotate qiime_diversity_alpha-phylogenetic.xml @ 0:09b7bcb72fa7 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 02:11:44 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity_alpha-phylogenetic" name="qiime diversity alpha-phylogenetic" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Alpha diversity (phylogenetic)</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 qiime diversity alpha-phylogenetic --i-phylogeny=$iphylogeny --i-table=$itable --p-metric=$pmetric
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 --o-alpha-diversity=oalphadiversity;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 cp oalphadiversity.qza $oalphadiversity;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Frequency] The feature table containing the samples for which alpha diversity should be computed. [required]" name="itable" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 <param format="qza,no_unzip.zip" label="--i-phylogeny: Phylogeny[Rooted] Phylogenetic tree containing tip identifiers that 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"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 <param label="--p-metric: " name="pmetric" optional="False" type="select" >
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 <option value="faith_pd">faith_pd</option>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 </param>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 <data format="qza" label="${tool.name} on ${on_string}: alpha-diversity.qza" name="oalphadiversity"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 <help><![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 Alpha diversity (phylogenetic)
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 ------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 Computes a user-specified phylogenetic alpha diversity metric for all
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 samples in a feature table.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 The feature table containing the samples for which alpha diversity
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 should be computed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 phylogeny : Phylogeny[Rooted]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 Phylogenetic tree containing tip identifiers that correspond to the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 feature identifiers in the table. This tree can contain tip ids that
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 are not present in the table, but all feature ids in the table must be
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 present in this tree.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 metric : Str % Choices({'faith_pd'})
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 The alpha diversity metric to be computed.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 alpha_diversity : SampleData[AlphaDiversity] % Properties(['phylogenetic'])
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 Vector containing per-sample alpha diversities.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 </tool>