annotate qiime_gneiss_dendrogram-heatmap.xml @ 0:09b7bcb72fa7 draft

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