annotate qiime2-2020.8/qiime_diversity-lib_weighted-unifrac.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_diversity-lib_weighted-unifrac" name="qiime diversity-lib weighted-unifrac"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Weighted Unifrac</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime diversity-lib weighted-unifrac
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 --i-phylogeny=$iphylogeny
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pthreads) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16 --p-threads=$pthreads
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 #if $pbypasstips:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 --p-bypass-tips
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 --o-distance-matrix=odistancematrix
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 cp odistancematrix.qza $odistancematrix
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency | RelativeFrequency] The feature table containing the samples for which Weighted Unifrac should be computed. [required]" name="itable" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 <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" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36 <param label="--p-threads: " name="pthreads" optional="True" type="select">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37 <option selected="True" value="None">Selection is Optional</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38 <option value="Int % Range(1">Int % Range(1</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39 <option value="None">None</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 </param>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--p-bypass-tips: --p-bypass-tips: / --p-no-bypass-tips In a bifurcating tree, the tips make up about 50% of the nodes in a tree. By ignoring them, specificity can be traded for reduced compute time. This has the effect of collapsing the phylogeny, and is analogous (in concept) to moving from 99% to 97% OTUs [default: False]" name="pbypasstips" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 Weighted Unifrac
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 Compute Weighted Unifrac for each sample in a feature table
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 table : FeatureTable[Frequency | RelativeFrequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 The feature table containing the samples for which Weighted Unifrac
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 should be computed.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 phylogeny : Phylogeny[Rooted]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 Phylogenetic tree containing tip identifiers that correspond to the
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 feature identifiers in the table. This tree can contain tip ids that
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 are not present in the table, but all feature ids in the table must be
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66 present in this tree.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 threads : Int % Range(1, None) | Str % Choices('auto'), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68 The number of CPU threads to use in performing this calculation. May
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 not exceed the number of available physical cores. If threads = 'auto',
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 one thread will be created for each identified CPU core on the host.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71 bypass_tips : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72 In a bifurcating tree, the tips make up about 50% of the nodes in a
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73 tree. By ignoring them, specificity can be traded for reduced compute
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74 time. This has the effect of collapsing the phylogeny, and is analogous
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 (in concept) to moving from 99% to 97% OTUs
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
79 distance_matrix : DistanceMatrix
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
80 Distance matrix for Unweighted Unifrac.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
81 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
82 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
83 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
84 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
85 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
86 </tool>