annotate execute_dwt_IvC_all.xml @ 1:509993d9fdca draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
author devteam
date Mon, 06 Jul 2020 18:12:29 +0000
parents 91fad0f30fd3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
1 <tool id="compute_p-values_second_moments_feature_occurrences_between_two_datasets_using_discrete_wavelet_transfom" name="Compute P-values and Second Moments for Feature Occurrences" version="1.0.1">
0
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
2 <description>between two datasets using Discrete Wavelet Transfoms</description>
1
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
3 <requirements>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
4 <requirement type="package" version="1.7.5">r-waveslim</requirement>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
5 <requirement type="package" version="4.6.8">r-wavethresh</requirement>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
6 </requirements>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
7 <command detect_errors="exit_code">
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
8 Rscript --vanilla '$__tool_directory__/execute_dwt_IvC_all.R'
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
9 '$inputFile1'
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
10 '$inputFile2'
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
11 '$outputFile2'
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
12 '$outputFile1'
0
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
13 </command>
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
14 <inputs>
1
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
15 <param format="tabular" name="inputFile1" type="data" label="Select the first input file"/>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
16 <param format="tabular" name="inputFile2" type="data" label="Select the second input file"/>
0
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
17 </inputs>
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
18 <outputs>
1
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
19 <data format="tabular" name="outputFile1" label="${tool.name} on ${on_string}: statistics"/>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
20 <data format="pdf" name="outputFile2" label="${tool.name} on ${on_string}: pdf"/>
0
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
21 </outputs>
1
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
22 <tests>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
23 <test>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
24 <param ftype="tabular" name="inputFile1" value="in1.tsv"/>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
25 <param ftype="tabular" name="inputFile2" value="in2.tsv"/>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
26 <output name="outputFile1" ftype="tabular">
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
27 <assert_contents><has_line_matching expression="^motif\t1_moment2.*"/></assert_contents>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
28 <assert_contents><has_line_matching expression="^translinTarget.*" /></assert_contents>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
29 </output>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
30 <output name="outputFile2" ftype="pdf" file="out2.pdf" compare="sim_size"/>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
31 </test>
509993d9fdca "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_ivc_all commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
32 </tests>
0
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
33 <help>
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
34
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
35 .. class:: infomark
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
36
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
37 **What it does**
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
38
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
39 This program generates plots and computes table matrix of second moments, p-values, and test orientations at multiple scales for the correlation between the occurrences of features in one dataset and their occurrences in another using multiscale wavelet analysis technique.
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
40
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
41 The program assumes that the user has two sets of DNA sequences, S1 and S1, each of which consists of one or more sequences of equal length. Each sequence in each set is divided into the same number of multiple intervals n such that n = 2^k, where k is a positive integer and k >= 1. Thus, n could be any value of the set {2, 4, 8, 16, 32, 64, 128, ...}. k represents the number of scales.
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
42
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
43 The program has two input files obtained as follows:
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
44
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
45 For a given set of features, say motifs, the user counts the number of occurrences of each feature in each interval of each sequence in S1 and S1, and builds two tabular files representing the count results in each interval of S1 and S1. These are the input files of the program.
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
46
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
47 The program gives two output files:
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
48
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
49 - The first output file is a TABULAR format file representing the second moments, p-values, and test orientations for each feature at each scale.
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
50 - The second output file is a PDF file consisting of as many figures as the number of features, such that each figure represents the values of the second moment for that feature at every scale.
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
51
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
52 -----
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
53
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
54 .. class:: warningmark
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
55
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
56 **Note**
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
57
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
58 In order to obtain empirical p-values, a random perumtation test is implemented by the program, which results in the fact that the program gives slightly different results each time it is run on the same input file.
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
59
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
60 -----
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
61
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
62 **Example**
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
63
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
64 Counting the occurrences of 5 features (motifs) in 16 intervals (one line per interval) of the DNA sequences in S1 gives the following tabular file::
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
65
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
66 deletionHoptspot insertionHoptspot dnaPolPauseFrameshift topoisomeraseCleavageSite translinTarget
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
67 226 403 416 221 1165
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
68 236 444 380 241 1223
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
69 242 496 391 195 1116
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
70 243 429 364 191 1118
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
71 244 410 371 236 1063
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
72 230 386 370 217 1087
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
73 275 404 402 214 1044
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
74 265 443 365 231 1086
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
75 255 390 354 246 1114
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
76 281 384 406 232 1102
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
77 263 459 369 251 1135
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
78 280 433 400 251 1159
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
79 278 385 382 231 1147
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
80 248 393 389 211 1162
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
81 251 403 385 246 1114
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
82 239 383 347 227 1172
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
83
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
84 And counting the occurrences of 5 features (motifs) in 16 intervals (one line per interval) of the DNA sequences in S2 gives the following tabular file::
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
85
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
86 deletionHoptspot insertionHoptspot dnaPolPauseFrameshift topoisomeraseCleavageSite translinTarget
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
87 235 374 407 257 1159
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
88 244 356 353 212 1128
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
89 233 343 322 204 1110
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
90 222 329 398 253 1054
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
91 216 325 328 253 1129
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
92 257 368 352 221 1115
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
93 238 360 346 224 1102
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
94 225 350 377 248 1107
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
95 230 330 365 236 1132
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
96 241 389 357 220 1120
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
97 274 354 392 235 1120
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
98 250 379 354 210 1102
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
99 254 329 320 251 1080
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
100 221 355 406 279 1127
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
101 224 330 390 249 1129
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
102 246 366 364 218 1176
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
103
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
104
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
105 We notice that the number of scales here is 4 because 16 = 2^4. Runnig the program on the above input files gives the following output:
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
106
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
107 The first output file::
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
108
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
109 motif 1_moment2 1_pval 1_test 2_moment2 2_pval 2_test 3_moment2 3_pval 3_test 4_moment2 4_pval 4_test
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
110
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
111 deletionHoptspot 0.8751 0.376 L 1.549 0.168 R 0.6152 0.434 L 0.5735 0.488 R
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
112 insertionHoptspot 0.902 0.396 L 1.172 0.332 R 0.6843 0.456 L 1.728 0.213 R
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
113 dnaPolPauseFrameshift 1.65 0.013 R 0.267 0.055 L 0.1387 0.124 L 0.4516 0.498 L
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
114 topoisomeraseCleavageSite 0.7443 0.233 L 1.023 0.432 R 1.933 0.155 R 1.09 0.3 R
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
115 translinTarget 0.5084 0.057 L 0.8219 0.446 L 3.604 0.019 R 0.4377 0.492 L
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
116
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
117 The second output file:
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
118
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
119 .. image:: ${static_path}/operation_icons/dwt_IvC_1.png
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
120 .. image:: ${static_path}/operation_icons/dwt_IvC_2.png
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
121 .. image:: ${static_path}/operation_icons/dwt_IvC_3.png
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
122 .. image:: ${static_path}/operation_icons/dwt_IvC_4.png
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
123 .. image:: ${static_path}/operation_icons/dwt_IvC_5.png
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
124
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
125 </help>
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
126
91fad0f30fd3 Imported from capsule None
devteam
parents:
diff changeset
127 </tool>