annotate qiime2-2020.8/qiime_diversity-lib_faith-pd.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-lib_faith-pd" name="qiime diversity-lib faith-pd"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Faith\'s Phylogenetic Diversity</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-lib faith-pd
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 #if $itable:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12 --i-table
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 --i-phylogeny=$iphylogeny
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 --o-vector=ovector
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 ovector.qza $ovector
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: --i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency | PresenceAbsence] The feature table containing the samples for which Faith\'s phylogenetic diversity should be computed. Table values will be converted to presence/absence. [required]" name="itable" selected="False" type="boolean" />
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="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
31
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
32 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 <data format="qza" label="${tool.name} on ${on_string}: vector.qza" name="ovector" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 Faith\'s Phylogenetic Diversity
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 Computes Faith's Phylogenetic Diversity for all samples in a feature table.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 table : FeatureTable[Frequency | RelativeFrequency | PresenceAbsence]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48 The feature table containing the samples for which Faith's phylogenetic
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 diversity should be computed. Table values will be converted to
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 presence/absence.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 phylogeny : Phylogeny[Rooted]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 Phylogenetic tree containing tip identifiers that correspond to the
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 feature identifiers in the table. This tree can contain tip ids that
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 are not present in the table, but all feature ids in the table must be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 present in this tree.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 vector : SampleData[AlphaDiversity]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 Vector containing per-sample values for Faith's Phylogenetic Diversity.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 </tool>