annotate qiime2/qiime_diversity-lib_unweighted-unifrac.xml @ 29:3ba9833030c1 draft

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