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