annotate qiime2/qiime_gneiss_dendrogram-heatmap.xml @ 11:ea7a1c6be3c4 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:37:40 +0000
parents f190567fe3f6
children a0a8d77a991c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
2 <tool id="qiime_gneiss_dendrogram-heatmap" name="qiime gneiss dendrogram-heatmap" version="2019.7">
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Dendrogram heatmap.</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
9
f190567fe3f6 Uploaded
florianbegusch
parents: 6
diff changeset
5 <requirement type="package" version="2019.7">qiime2</requirement>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime gneiss dendrogram-heatmap
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-tree=$itree
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
6
florianbegusch
parents: 0
diff changeset
27 #if str($ppseudocount):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --p-pseudocount=$ppseudocount
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30
6
florianbegusch
parents: 0
diff changeset
31 #if str($pndim):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 --p-ndim=$pndim
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #if str($pmethod) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 --p-method=$pmethod
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #if str($pcolormap) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 --p-color-map=$pcolormap
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table that will be plotted as a heatmap. This table is assumed to have strictly positive values. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <param format="qza,no_unzip.zip" label="--i-tree: ARTIFACT A hierarchy of feature identifiers where each Hierarchy tipcorresponds 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="itree" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] Categorical metadata column to group the samples. [required]" name="mmetadatacolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <param label="--p-pseudocount: NUMBER The pseudocount to add to avoid division by zero. [default: 0.5]" name="ppseudocount" optional="True" type="float" value="0.5"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--p-ndim: INTEGER Number of dimensions to highlight. [default: 10]" name="pndim" optional="True" type="integer" value="10"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--p-method: " name="pmethod" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <option value="clr">clr</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option value="log">log</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <param label="--p-color-map: " name="pcolormap" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="viridis">viridis</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <option value="inferno">inferno</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="plasma">plasma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="magma">magma</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <option value="Blues">Blues</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <option value="BuGn">BuGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 <option value="BuPu">BuPu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 <option value="GnBu">GnBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <option value="Greens">Greens</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <option value="Greys">Greys</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 <option value="Oranges">Oranges</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="OrRd">OrRd</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="PuBu">PuBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="PuBuGn">PuBuGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 <option value="PuRd">PuRd</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 <option value="Purples">Purples</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 <option value="RdPu">RdPu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="Reds">Reds</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="YlGn">YlGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 <option value="YlGnBu">YlGnBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 <option value="YlOrBr">YlOrBr</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <option value="YlOrRd">YlOrRd</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <option value="afmhot">afmhot</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 <option value="autumn">autumn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <option value="bone">bone</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 <option value="cool">cool</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <option value="copper">copper</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <option value="gist_heat">gist_heat</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 <option value="gray">gray</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <option value="hot">hot</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 <option value="pink">pink</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 <option value="spring">spring</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 <option value="summer">summer</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 <option value="winter">winter</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 <option value="BrBG">BrBG</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 <option value="bwr">bwr</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 <option value="coolwarm">coolwarm</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <option value="PiYG">PiYG</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <option value="PRGn">PRGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <option value="PuOr">PuOr</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <option value="RdBu">RdBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 <option value="RdGy">RdGy</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <option value="RdYlBu">RdYlBu</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 <option value="RdYlGn">RdYlGn</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 <option value="Spectral">Spectral</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 <option value="seismic">seismic</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 <option value="Accent">Accent</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 <option value="Dark2">Dark2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 <option value="Paired">Paired</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 <option value="Pastel1">Pastel1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <option value="Pastel2">Pastel2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <option value="Set1">Set1</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 <option value="Set2">Set2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 <option value="Set3">Set3</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 <option value="Vega10">Vega10</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117 <option value="Vega20">Vega20</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 <option value="Vega20b">Vega20b</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 <option value="Vega20c">Vega20c</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 <option value="gist_earth">gist_earth</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
121 <option value="terrain">terrain</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
122 <option value="ocean">ocean</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 <option value="gist_stern">gist_stern</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
124 <option value="brg">brg</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
125 <option value="CMRmap">CMRmap</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
126 <option value="cubehelix">cubehelix</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
127 <option value="gnuplot">gnuplot</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
128 <option value="gnuplot2">gnuplot2</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
129 <option value="gist_ncar">gist_ncar</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
130 <option value="nipy_spectral">nipy_spectral</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
131 <option value="jet">jet</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
132 <option value="rainbow">rainbow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
133 <option value="gist_rainbow">gist_rainbow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
134 <option value="hsv">hsv</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
135 <option value="flag">flag</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
136 <option value="prism">prism</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
137 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
138
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
139 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
140 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
141 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
142
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
143 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
144 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
145 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
146 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
147 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
148 Dendrogram heatmap.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
149 ###################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
150
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
151 Visualize the feature table as a heatmap, with samples sorted along a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
152 specified categorical metadata column and features clustered together
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
153 specified by the tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
154
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
155 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
156 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
157 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
158 The feature table that will be plotted as a heatmap. This table is
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
159 assumed to have strictly positive values.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
160 tree : Hierarchy
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
161 A hierarchy of feature identifiers where each tipcorresponds to the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
162 feature identifiers in the table. This tree can contain tip ids that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
163 are not present in the table, but all feature ids in the table must be
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
164 present in this tree.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
165 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
166 Categorical metadata column to group the samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
167 pseudocount : Float, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
168 The pseudocount to add to avoid division by zero.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
169 ndim : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
170 Number of dimensions to highlight.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
171 method : Str % Choices('clr', 'log'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
172 Specifies how the data should be normalized for display.Options include
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
173 'log' or 'clr' (default='clr').
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
174 color_map : Str % Choices('viridis', 'inferno', 'plasma', 'magma', 'Blues', 'BuGn', 'BuPu', 'GnBu', 'Greens', 'Greys', 'Oranges', 'OrRd', 'PuBu', 'PuBuGn', 'PuRd', 'Purples', 'RdPu', 'Reds', 'YlGn', 'YlGnBu', 'YlOrBr', 'YlOrRd', 'afmhot', 'autumn', 'bone', 'cool', 'copper', 'gist_heat', 'gray', 'hot', 'pink', 'spring', 'summer', 'winter', 'BrBG', 'bwr', 'coolwarm', 'PiYG', 'PRGn', 'PuOr', 'RdBu', 'RdGy', 'RdYlBu', 'RdYlGn', 'Spectral', 'seismic', 'Accent', 'Dark2', 'Paired', 'Pastel1', 'Pastel2', 'Set1', 'Set2', 'Set3', 'Vega10', 'Vega20', 'Vega20b', 'Vega20c', 'gist_earth', 'terrain', 'ocean', 'gist_stern', 'brg', 'CMRmap', 'cubehelix', 'gnuplot', 'gnuplot2', 'gist_ncar', 'nipy_spectral', 'jet', 'rainbow', 'gist_rainbow', 'hsv', 'flag', 'prism'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
175 Specifies the color map for plotting the heatmap. See
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
176 https://matplotlib.org/examples/color/colormaps_reference.html for more
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
177 details.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
178
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
179 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
180 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
181 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
182 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
183 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
184 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
185 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
186 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
187 </tool>