Mercurial > repos > fabio > iwtomics

comparison iwtomics_tour.yaml @ 89:e089b19da14c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded 20180221
author fabio
date Wed, 21 Feb 2018 11:07:29 -0500
parents
children
comparison
equal deleted inserted replaced
88:422189e4041e 89:e089b19da14c
1 id: iwtomics_galaxy
2 name: IWTomics Tour
3 description: An interactive tour for the Interval-Wise Testing for omics data (IWTomics) tool for Galaxy
4 title_default: "Welcome to IWTomics"
5
6 steps:
7 - title: "Welcome to IWTomics"
8 content: "IWTomics is a tool to statistically evaluate differences in genomic features between groups of regions along the genome. This tour will guide you through a real data example. Please follow the instructions (interaction is required)."
9 backdrop: true
10
11 ######################
12 ## load ETn example ##
13 ######################
14
15 - title: "Upload data"
16 element: ".upload-button"
17 intro: "Upload BED files with the groups of regions to be compared, and TXT files with the corresponding genomic feature measurements."
18 position: "right"
19 postclick:
20 - ".upload-button"
21 - "#btn-new"
22
23 - title: "Upload data"
24 element: ".upload-text-content:first"
25 intro: "ETn example: real data from Campos-Sànchez et al. (2016). Upload 'Fixed ETn' and 'Control' regions, as well as 'Recombination Hotspot' content."
26 position: "top"
27 textinsert: |
28 https://raw.githubusercontent.com/fabio-cumbo/IWTomics4Galaxy/master/ETn_example/DESCRIPTION.txt
29 https://raw.githubusercontent.com/fabio-cumbo/IWTomics4Galaxy/master/ETn_example/ETn_fixed.bed
30 https://raw.githubusercontent.com/fabio-cumbo/IWTomics4Galaxy/master/ETn_example/Control.bed
31 https://raw.githubusercontent.com/fabio-cumbo/IWTomics4Galaxy/master/ETn_example/Recombination_hotspots.txt
32
33 - title: "Select automatic file type"
34 element: ".upload-extension:first"
35 intro: "INTERACTION REQUIRED: Select 'Auto-detect' type, then click 'Next'."
36 position: "top"
37 # does not work: let the user select the 'tabular' data type for headers
38 #textinsert: "tabular"
39
40 - title: "Start uploading data"
41 element: "#btn-start"
42 intro: "Upload files into Galaxy history."
43 position: "top"
44 postclick:
45 - "#btn-start"
46
47 - title: "Wait"
48 element: ".upload-text-content:first"
49 intro: "Wait until this block is green, then click 'Next'."
50 position: "bottom"
51 postclick:
52 - "#btn-reset"
53 - "#btn-new"
54
55 - title: "Upload data"
56 element: ".upload-text-content:first"
57 intro: "ETn example: real data from Campos-Sànchez et al. (2016). Upload header files for regions and features."
58 position: "top"
59 textinsert: |
60 https://raw.githubusercontent.com/fabio-cumbo/IWTomics4Galaxy/master/ETn_example/regions_header.tabular
61 https://raw.githubusercontent.com/fabio-cumbo/IWTomics4Galaxy/master/ETn_example/features_header.tabular
62
63 - title: "Select header file type"
64 element: ".upload-extension:first"
65 intro: "INTERACTION REQUIRED: Select 'tabular' type, then click 'Next'."
66 position: "top"
67 # does not work: let the user select the 'tabular' data type for headers
68 #textinsert: "tabular"
69
70 - title: "Start uploading header files"
71 element: "#btn-start"
72 intro: "Upload files into Galaxy history."
73 position: "top"
74 postclick:
75 - "#btn-start"
76
77 - title: "Close upload/download manager"
78 element: "#btn-close"
79 intro: "Close the upload manager with this button or with a click outside of the manager window."
80 position: "top"
81 postclick:
82 - "#btn-close"
83
84 - title: "Description File"
85 element: "#current-history-panel .list-item:eq(5)"
86 intro: "DESCRIPTION.txt contains a description of the ETn dataset. Click on the eye symbol to inspect it."
87 position: "left"
88
89 - title: "Fixed ETn Regions"
90 element: "#current-history-panel .list-item:eq(4)"
91 intro: "ETn_fixed.bed contains genomic coordinates of 1296 64-kb regions flanking fixed ETn elements (elements of the Early Transposon family of active Endogenous Retroviruses in mouse). Click on the eye symbol to inspect it."
92 position: "left"
93
94 - title: "Control Regions"
95 element: "#current-history-panel .list-item:eq(3)"
96 intro: "Control.bed contains genomic coordinates of 1142 64-kb regions that do not overlap ETn flanking regions. Click on the eye symbol to inspect it."
97 position: "left"
98
99 - title: "Recombination Hotspot Content"
100 element: "#current-history-panel .list-item:eq(2)"
101 intro: "Recombination_hotspots.txt contains genomic coordinates of 2438 64-kb regions (Fixed ETn and Control regions) and, for each of them, the recombination hotspot content measured in 64 1-kb windows. Click on the eye symbol to inspect it."
102 position: "left"
103
104 - title: "Region Header"
105 element: "#current-history-panel .list-item:eq(1)"
106 intro: "regions.header contains an identifier for each region dataset and the name to be used in the output. Click on the eye symbol to inspect it."
107 position: "left"
108
109 - title: "Feature Header"
110 element: "#current-history-panel .list-item:eq(0)"
111 intro: "features.header contains an identifier for each feature and the name to be used in the output. Click on the eye symbol to inspect it."
112 position: "left"
113
114 - title: "Search for the IWTomics suite"
115 element: "#tool-search-query"
116 intro: "INTERACTION REQUIRED: Write 'IWTomics' in the search field. The IWTomics suite contains three tools: 'Load, Smooth and Plot', 'Test and Plot', and 'Plot with Threshold on Test Scale'. Those tools should be used sequentially. Click 'Next' to continue the tour."
117 position: "right"
118
119 #####################################
120 ## start Load Smooth and Plot tool ##
121 #####################################
122
123 - title: "Select 'Load, Smooth and Plot' tool"
124 element: 'a[href$="tool_runner?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fiwtomics_loadandplot%2Fiwtomics_loadandplot%2F1.0.0.0"]'
125 intro: "Select the first tool 'Load, Smooth and Plot'."
126 position: "right"
127 postclick:
128 - 'a[href$="tool_runner?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fiwtomics_loadandplot%2Fiwtomics_loadandplot%2F1.0.0.0"]'
129
130 - title: "'Load, Smooth and Plot' tool"
131 content: "'Load, Smooth and Plot' tool imports the genomic region datasets and the corresponding feature measurements."
132 backdrop: true
133
134 - title: "Select region datasets"
135 element: 'div[tour_id$="regions"]'
136 intro: "INTERACTION REQUIRED: select the two region datasets 'ETn_fixed.bed' and 'Control.bed', then click 'Next'."
137 position: "bottom"
138 # does not work: let the user select the input
139 #preclick:
140 #- >-
141 #div[tour_id$="regions"] > div[class$="ui-form-field"] >
142 #div[class$="ui-select-content"] > div[class$="ui-select"] >
143 #select[class$="select"] > option:eq(3)
144 #- >-
145 #div[tour_id$="regions"] > div[class$="ui-form-field"] >
146 #div[class$="ui-select-content"] > div[class$="ui-select"] >
147 #select[class$="select"] > option:eq(4)
148
149 - title: "Select region header"
150 element: 'div[tour_id$="regionsheader"]'
151 intro: "INTERACTION REQUIRED: select the region header file 'regions_header.tabular', then click 'Next'."
152 position: "bottom"
153 # does not work: let the user select the input
154 #preclick:
155 #- 'div[tour_id$="regionsheader"] ul[role$="listbox"] li:eq(3)' # oppure 2 se 'Nothing selected' non conta
156
157 - title: "Select feature datasets"
158 element: 'div[tour_id$="features"]'
159 intro: "INTERACTION REQUIRED: select the feature file 'Recombination_hotspot.txt', then click 'Next'."
160 position: "bottom"
161 # does not work: let the user select the input
162 #preclick:
163 #- >-
164 #div[tour_id$="features"] > div[class$="ui-form-field"] >
165 #div[class$="ui-select-content"] > div[class$="ui-select"] >
166 #select[class$="select"] > option:eq(1)
167
168 - title: "Select feature header"
169 element: 'div[tour_id$="featuresheader"]'
170 intro: "INTERACTION REQUIRED: select the feature header file 'features_header.tabular', then click 'Next'"
171 position: "top"
172 # does not work: let the user select the input
173 #preclick:
174 #- 'div[tour_id$="featuresheader"] ul[role$="listbox"] li:eq(1)' # oppure 0 se 'Nothing selected' non conta
175
176 - title: "Select start positions"
177 element: 'div[tour_id$="zerobased"]'
178 intro: "Start positions are 0-based in this example."
179 position: "top"
180
181 - title: "Select smoothing"
182 element: 'div[tour_id$="conditionaltype|smoothing"]'
183 intro: "Select the type of smoothing to be applied to the feature curves. Default is 'No' smoothing. Other choices include 'Local Polynomials', 'Gaussian Kernel', and 'B-Splines'."
184 position: "top"
185
186 - title: "Select region alignment"
187 element: 'div[tour_id$="conditionaltype|alignment"]'
188 intro: "Select region alignment. Default is 'Center', that alignes regions on their central position. Other choices include 'Left', 'Right', and 'Scale' alignments ('Scale' can only be used if smoothing is applied). In this example all regions have the same length, so the four alignment types are equivalent."
189 position: "top"
190
191 - title: "Plot the mean curves"
192 element: 'div[tour_id$="plotres|average"]'
193 intro: "If 'Yes' is selected, a mean feature curve is plotted for each region dataset."
194 position: "top"
195
196 - title: "Plot sample size in each position"
197 element: 'div[tour_id$="plotres|size"]'
198 intro: "If 'Yes' is selected, an heatmap with the sample size in each position is plotted for each region dataset."
199 position: "top"
200
201 - title: "Select plot type"
202 element: 'div[tour_id$="plotres|conditionalplottype|plottype"]'
203 intro: "Select the graphical representation type: 'Pointwise quantile curves (boxplot)' or 'Curves (aligned)'. In this example we draw a pointwise boxplot."
204 position: "top"
205
206 - title: "Select probabilities"
207 element: 'div[tour_id$="plotres|conditionalplottype|probabilitiessection|prob0"]'
208 intro: "Select the probabilities corresponding to the quantile curves to be drawn. Default option is 0.25, 0.50, and 0.75."
209 position: "top"
210
211 - title: "Execute 'Load, Smooth and Plot' tool"
212 element: '#execute'
213 intro: "Execute the tool."
214 position: "right"
215 postclick:
216 - '#execute'
217
218 - title: "Wait"
219 content: "Wait until the results are created, then click 'Next'."
220 backdrop: true
221
222 - title: "IWTomicsData Object"
223 element: "#current-history-panel .list-item:eq(3)"
224 intro: "This is an RData with the IWTomicsData object, that stores the aligned genomic region datasets, and their associated feature measurements."
225 position: "left"
226
227 - title: "Region Dataset IDs"
228 element: "#current-history-panel .list-item:eq(2)"
229 intro: "Region Dataset IDs contains the region datasets identifiers. Click on the eye symbol to inspect it."
230 position: "left"
231
232 - title: "Feature IDs"
233 element: "#current-history-panel .list-item:eq(1)"
234 intro: "Feature IDs contains the feature identifiers. Click on the eye symbol to inspect it."
235 position: "left"
236
237 - title: "Plotted Data"
238 element: "#current-history-panel .list-item:eq(0)"
239 intro: "Plotted Data is a PDF with the pointwise boxplots. Click on the eye symbol to inspect it."
240 position: "left"
241
242 - title: "'Load, Smooth and Plot' completed"
243 content: "The 'Load, Smooth and Plot' tool demonstration is completed. Click 'Next' to continue with the tool 'Test and Plot'."
244 backdrop: true
245
246 ##############################
247 ## start Test and Plot tool ##
248 ##############################
249
250 - title: "Select 'Test and Plot' tool"
251 element: 'a[href$="tool_runner?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fiwtomics_testandplot%2Fiwtomics_testandplot%2F1.0.0.0"]'
252 intro: "Select 'Test and Plot' tool."
253 position: "right"
254 postclick:
255 - 'a[href$="tool_runner?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fiwtomics_testandplot%2Fiwtomics_testandplot%2F1.0.0.0"]'
256
257 - title: "'Test and Plot' tool"
258 content: "'Test and Plot' tool statistically evaluates differences in feature measurements between pairs of genomic region datasets. In particular, it implements the Interval-Wise Testing for omics data."
259 backdrop: true
260
261 - title: "Select IWTomicsData object"
262 element: 'div[tour_id$="rdata"]'
263 intro: "INTERACTION REQUIRED: select the IWTomicsData Object created by 'Load, Smooth and Plot' tool, then click 'Next'."
264 position: "bottom"
265
266 - title: "Select region dataset IDs"
267 element: 'div[tour_id$="regionids"]'
268 intro: "INTERACTION REQUIRED: select the Region Dataset IDs created by 'Load, Smooth and Plot' tool, then click 'Next'."
269 position: "bottom"
270
271 - title: "Select feature IDs"
272 element: 'div[tour_id$="featureids"]'
273 intro: "INTERACTION REQUIRED: select the Feature IDs created by 'Load, Smooth and Plot' tool, then click 'Next'."
274 position: "bottom"
275
276 - title: "Select regions for Interval-Wise Testing"
277 element: 'div[tour_id$="regionssection|regions_0|region0"]'
278 intro: "INTERACTION REQUIRED: select pairs of genomic region datasets to be compared using two-sample Interval-Wise Testing. In this example we consider one two-sample test contrasting 'ETn_fixed' (select it as 'Region 1') to 'Control' (select it as 'Region 2'), then click 'Next'."
279 position: "top"
280
281 - title: "Select features"
282 element: 'div[tour_id$="featureslist"]'
283 intro: "INTERACTION REQUIRED: select feature measurements to be tested. In this example, select 'Recomb_hot' feature, then click 'Next'."
284 position: "top"
285
286 - title: "Select test statistics"
287 element: 'div[tour_id$="conditionalstatistics|statistics"]'
288 intro: "Select the test statistics to be employed in the test. Default is 'Mean difference'. Other choices are 'Median difference', 'Variance ratio', and 'Quantile difference(s)'."
289 position: "top"
290
291 - title: "Select number of permutations"
292 element: 'div[tour_id$="permutations"]'
293 intro: "Select number of permutations to be used to compute p-values."
294 position: "top"
295
296 - title: "Select alpha"
297 element: 'div[tour_id$="plotres|alpha"]'
298 intro: "Select the level alpha of the test (significance level of the test)."
299 position: "top"
300
301 - title: "Plot the mean curves"
302 element: 'div[tour_id$="plotres|average"]'
303 intro: "If 'Yes' is selected, a mean feature curve is plotted for each region dataset."
304 position: "top"
305
306 - title: "Plot sample size in each position"
307 element: 'div[tour_id$="plotres|size"]'
308 intro: "If 'Yes' is selected, an heatmap with the sample size in each position is plotted for each region dataset."
309 position: "top"
310
311 - title: "Select plot type"
312 element: 'div[tour_id$="plotres|conditionalplottype|plottype"]'
313 intro: "Select the graphical representation type: 'Pointwise quantile curves (boxplot)' or 'Curves (aligned)'. In this example we draw a pointwise boxplot."
314 position: "top"
315
316 - title: "Select probabilities"
317 element: 'div[tour_id$="plotres|conditionalplottype|probabilitiessection|prob0"]'
318 intro: "Select the probabilities corresponding to the quantile curves to be drawn. Default option is 0.25, 0.50, and 0.75."
319 position: "top"
320
321 - title: "Select summary plot"
322 element: 'div[tour_id$="plotsum|conditionalgroupby|groupby"]'
323 intro: "Select the summary plot to be drawn. Default is 'No plot'. Other choices are a summary plot for each test ('Group by test') and a summary plot for each feature ('Group by feature'). In this example we are performing only one test on one feature, so we select 'No plot'."
324 position: "top"
325
326 - title: "Execute 'Test and Plot' tool"
327 element: '#execute'
328 intro: "Execute the tool."
329 position: "right"
330 postclick:
331 - '#execute'
332
333 - title: "Wait"
334 content: "Wait until the results are created, then click 'Next'."
335 backdrop: true
336
337 - title: "Adjusted p-value Matrix"
338 element: "#current-history-panel .list-item:eq(5)"
339 intro: "This is a TXT file with an adjusted p-value matrix for every test performed. Each matrix contains a p-value curve (row) for every scale considered in the test. Click on the eye symbol to inspect it."
340 position: "left"
341
342 - title: "Plotted Test Results"
343 element: "#current-history-panel .list-item:eq(4)"
344 intro: "Plotted Test Results is a PDF file with the plotted test results. Click on the eye symbol to inspect it."
345 position: "left"
346
347 - title: "Summary Plot"
348 element: "#current-history-panel .list-item:eq(3)"
349 intro: "If a summary plot was selected in 'Test and Plot' tool, this is a PDF file with the summary plot. If 'No plot' was selected, this is empty."
350 position: "left"
351
352 - title: "IWTomicsData Object with Test Results"
353 element: "#current-history-panel .list-item:eq(2)"
354 intro: "This is an RData with the IWTomicsData Object with the test results."
355 position: "left"
356
357 - title: "Test IDs"
358 element: "#current-history-panel .list-item:eq(1)"
359 intro: "Test IDs contains the test identifiers. Click on the eye symbol to inspect it."
360 position: "left"
361
362 - title: "Feature IDs"
363 element: "#current-history-panel .list-item:eq(0)"
364 intro: "Feature IDs contains the feature identifiers. Click on the eye symbol to inspect it."
365 position: "left"
366
367 - title: "'Test and Plot' completed"
368 content: "The 'Test and Plot' tool demonstration is completed. Click 'Next' to continue with the tool 'Plot with Threshold on Test Scale'."
369 backdrop: true
370
371 #############################################
372 ## start Plot with Threshold on Test Scale ##
373 #############################################
374
375 - title: "Select 'Plot with Threshold on Test Scale' tool"
376 element: 'a[href$="tool_runner?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fiwtomics_plotwithscale%2Fiwtomics_plotwithscale%2F1.0.0.0"]'
377 intro: "Select 'Plot with Threshold on Test Scale' tool."
378 position: "right"
379 postclick:
380 - 'a[href$="tool_runner?tool_id=toolshed.g2.bx.psu.edu%2Frepos%2Fiuc%2Fiwtomics_plotwithscale%2Fiwtomics_plotwithscale%2F1.0.0.0"]'
381
382 - title: "'Plot with Threshold on Test Scale' tool"
383 content: "'Plot with Threshold on Test Scale' tool allows to select the scale for the Interval-Wise Testing results."
384 backdrop: true
385
386 - title: "Select IWTomicsData object with test results"
387 element: 'div[tour_id$="rdata"]'
388 intro: "INTERACTION REQUIRED: select the IWTomicsData Object with Test Results created by 'Test and Plot' tool, then click 'Next'."
389 position: "bottom"
390
391 - title: "Select test IDs"
392 element: 'div[tour_id$="testids"]'
393 intro: "INTERACTION REQUIRED: select the Test IDs created by 'Test and Plot' tool, then click 'Next'."
394 position: "bottom"
395
396 - title: "Select feature IDs"
397 element: 'div[tour_id$="featureids"]'
398 intro: "INTERACTION REQUIRED: select the Feature IDs created by 'Test and Plot' tool, then click 'Next'."
399 position: "bottom"
400
401 - title: "Select scale"
402 element: 'div[tour_id$="scalesection|thresholdontestscale_0|test"]'
403 intro: "INTERACTION REQUIRED: select the scale to be used in Interval-Wise Testing results and plot. First, select the test identifier 'ETn_fixed vs Control', then click 'Next'."
404 position: "top"
405
406 - title: "Select scale"
407 element: 'div[tour_id$="scalesection|thresholdontestscale_0|feature"]'
408 intro: "INTERACTION REQUIRED: select the feature identifier 'Recomb_hot', then click 'Next'."
409 position: "top"
410
411 - title: "Select scale"
412 element: 'div[tour_id$="scalesection|thresholdontestscale_0|scale"]'
413 intro: "INTERACTION REQUIRED: select the scale '8' (8-kb scale) for the test and feature selected above, then click 'Next'."
414 position: "top"
415
416 - title: "Select alpha"
417 element: 'div[tour_id$="plotres|alpha"]'
418 intro: "Select the level alpha of the test (significance level of the test)."
419 position: "top"
420
421 - title: "Plot the mean curves"
422 element: 'div[tour_id$="plotres|average"]'
423 intro: "If 'Yes' is selected, a mean feature curve is plotted for each region dataset."
424 position: "top"
425
426 - title: "Plot sample size in each position"
427 element: 'div[tour_id$="plotres|size"]'
428 intro: "If 'Yes' is selected, an heatmap with the sample size in each position is plotted for each region dataset."
429 position: "top"
430
431 - title: "Select plot type"
432 element: 'div[tour_id$="plotres|conditionalplottype|plottype"]'
433 intro: "Select the graphical representation type: 'Pointwise quantile curves (boxplot)' or 'Curves (aligned)'. In this example we draw a pointwise boxplot."
434 position: "top"
435
436 - title: "Select probabilities"
437 element: 'div[tour_id$="plotres|conditionalplottype|probabilitiessection|prob0"]'
438 intro: "Select the probabilities corresponding to the quantile curves to be drawn. Default option is 0.25, 0.50, and 0.75."
439 position: "top"
440
441 - title: "Select summary plot"
442 element: 'div[tour_id$="plotsum|conditionalgroupby|groupby"]'
443 intro: "Select the summary plot to be drawn. Default is 'No plot'. Other choices are a summary plot for each test ('Group by test') and a summary plot for each feature ('Group by feature'). In this example we are performing only one test on one feature, so we select 'No plot'."
444 position: "top"
445
446 - title: "Execute 'Plot with Threshold on Test Scale' tool"
447 element: '#execute'
448 intro: "Execute the tool."
449 position: "right"
450 postclick:
451 - '#execute'
452
453 - title: "Wait"
454 content: "Wait until the results are created, then click 'Next'."
455 backdrop: true
456
457 - title: "Adjusted p-value"
458 element: "#current-history-panel .list-item:eq(2)"
459 intro: "This is a TXT file with an adjusted p-value curve for every test performed at the selected scale. Click on the eye symbol to inspect it."
460 position: "left"
461
462 - title: "Plotted Test Results"
463 element: "#current-history-panel .list-item:eq(1)"
464 intro: "Plotted Test Results is a PDF file with the plotted test results, at the selected scale. Click on the eye symbol to inspect it."
465 position: "left"
466
467 - title: "Summary Plot"
468 element: "#current-history-panel .list-item:eq(0)"
469 intro: "If a summary plot was selected in 'Test and Plot' tool, this is a PDF file with the summary plot. If 'No plot' was selected, this is empty."
470 position: "left"
471
472 - title: "End of the tour"
473 content: "IWTomics tour is completed. Enjoy!"
474 backdrop: true