annotate qiime2/qiime_diversity-lib_faith-pd.xml @ 14:a0a8d77a991c draft

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