annotate qiime2/qiime_diversity_alpha-phylogenetic-alt.xml @ 10:21c7954105a9 draft

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