annotate execute_dwt_var_perClass.xml @ 1:781e68074f84 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
author devteam
date Mon, 06 Jul 2020 20:34:10 -0400
parents cb422b6f49d2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
1 <tool id="compute_p-values_max_variances_feature_occurrences_in_one_dataset_using_discrete_wavelet_transfom" name="Compute P-values and Max Variances for Feature Occurrences" version="1.0.1">
0
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
2 <description>in one dataset using Discrete Wavelet Transfoms</description>
1
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
3 <requirements>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
4 <requirement type="package" version="1.7.5">r-waveslim</requirement>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
5 <requirement type="package" version="4.6.8">r-wavethresh</requirement>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
6 </requirements>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
7 <command detect_errors="exit_code">
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
8 Rscript --vanilla '$__tool_directory__/execute_dwt_var_perClass.R'
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
9 '$inputFile'
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
10 '$outputFile1'
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
11 '$outputFile2'
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
12 '$outputFile3'
0
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
13 </command>
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
14 <inputs>
1
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
15 <param format="tabular" name="inputFile" type="data" label="Select the input file"/>
0
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
16 </inputs>
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
17 <outputs>
1
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
18 <data format="tabular" name="outputFile1" label="${tool.name} on ${on_string}: scales"/>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
19 <data format="tabular" name="outputFile2" label="${tool.name} on ${on_string}: statistics"/>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
20 <data format="pdf" name="outputFile3" label="${tool.name} on ${on_string}: pdf"/>
0
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
21 </outputs>
1
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
22 <tests>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
23 <test>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
24 <param ftype="tabular" name="inputFile" value="in.tsv"/>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
25 <output name="outputFile1" ftype="tabular">
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
26 <assert_contents><has_line_matching expression="^max_var\tscale.*"/></assert_contents>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
27 <assert_contents><has_line_matching expression="^translinTarget.*" /></assert_contents>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
28 </output>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
29 <output name="outputFile2" ftype="tabular">
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
30 <assert_contents><has_line_matching expression="^motif\t1_var.*"/></assert_contents>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
31 <assert_contents><has_line_matching expression="^translinTarget.*" /></assert_contents>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
32 </output>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
33 <output name="outputFile3" ftype="pdf" file="out.pdf" compare="sim_size"/>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
34 </test>
781e68074f84 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perclass commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 0
diff changeset
35 </tests>
0
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
36 <help>
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
37
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
38 .. class:: infomark
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
39
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
40 **What it does**
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
41
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
42 This program generates plots and computes table matrix of maximum variances, p-values, and test orientations at multiple scales for the occurrences of a class of features in one dataset of DNA sequences using multiscale wavelet analysis technique.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
43
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
44 The program assumes that the user has one set of DNA sequences, S, which consists of one or more sequences of equal length. Each sequence in S 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.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
45
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
46 The program has one input file obtained as follows:
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
47
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
48 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 S, and builds a tabular file representing the count results in each interval of S. This is the input file of the program.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
49
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
50 The program gives three output files:
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
51
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
52 - The first output file is a TABULAR format file giving the scales at which each features has a maximum variances.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
53 - The second output file is a TABULAR format file representing the variances, p-values, and test orientation for the occurrences of features at each scale based on a random permutation test and using multiscale wavelet analysis technique.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
54 - The third output file is a PDF file plotting the wavelet variances of each feature at each scale.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
55
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
56 -----
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
57
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
58 .. class:: warningmark
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
59
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
60 **Note**
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
61
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
62 - If the number of features is greater than 12, the program will divide each output file into subfiles, such that each subfile represents the results of a group of 12 features except the last subfile that will represents the results of the rest. For example, if the number of features is 17, the p-values file will consists of two subfiles, the first for the features 1-12 and the second for the features 13-17. As for the PDF file, it will consists of two pages in this case.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
63 - 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.
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
64
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
65 -----
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
66
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
67
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
68 **Example**
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
69
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
70 Counting the occurrences of 8 features (motifs) in 16 intervals (one line per interval) of set of DNA sequences in S gives the following tabular file::
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
71
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
72 deletionHoptspot insertionHoptspot dnaPolPauseFrameshift indelHotspot topoisomeraseCleavageSite translinTarget vDjRecombinationSignal x-likeSite
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
73 226 403 416 221 1165 832 749 1056
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
74 236 444 380 241 1223 746 782 1207
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
75 242 496 391 195 1116 643 770 1219
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
76 243 429 364 191 1118 694 783 1223
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
77 244 410 371 236 1063 692 805 1233
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
78 230 386 370 217 1087 657 787 1215
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
79 275 404 402 214 1044 697 831 1188
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
80 265 443 365 231 1086 694 782 1184
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
81 255 390 354 246 1114 642 773 1176
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
82 281 384 406 232 1102 719 787 1191
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
83 263 459 369 251 1135 643 810 1215
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
84 280 433 400 251 1159 701 777 1151
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
85 278 385 382 231 1147 697 707 1161
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
86 248 393 389 211 1162 723 759 1183
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
87 251 403 385 246 1114 752 776 1153
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
88 239 383 347 227 1172 759 789 1141
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
89
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
90 We notice that the number of scales here is 4 because 16 = 2^4. Runnig the program on the above input file gives the following 3 output files:
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
91
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
92 The first output file::
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
93
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
94 motifs max_var at scale
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
95 deletionHoptspot NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
96 insertionHoptspot NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
97 dnaPolPauseFrameshift NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
98 indelHotspot NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
99 topoisomeraseCleavageSite 3
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
100 translinTarget NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
101 vDjRecombinationSignal NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
102 x.likeSite NA
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
103
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
104 The second output file::
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
105
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
106 motif 1_var 1_pval 1_test 2_var 2_pval 2_test 3_var 3_pval 3_test 4_var 4_pval 4_test
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
107
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
108 deletionHoptspot 0.457 0.048 L 1.18 0.334 R 1.61 0.194 R 3.41 0.055 R
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
109 insertionHoptspot 0.556 0.109 L 1.34 0.272 R 1.59 0.223 R 2.02 0.157 R
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
110 dnaPolPauseFrameshift 1.42 0.089 R 0.66 0.331 L 0.421 0.305 L 0.121 0.268 L
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
111 indelHotspot 0.373 0.021 L 1.36 0.254 R 1.24 0.301 R 4.09 0.047 R
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
112 topoisomeraseCleavageSite 0.305 0.002 L 0.936 0.489 R 3.78 0.01 R 1.25 0.272 R
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
113 translinTarget 0.525 0.061 L 1.69 0.11 R 2.02 0.131 R 0.00891 0.069 L
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
114 vDjRecombinationSignal 0.68 0.138 L 0.957 0.46 R 2.35 0.071 R 1.03 0.357 R
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
115 x.likeSite 0.928 0.402 L 1.33 0.261 R 0.735 0.431 L 0.783 0.422 R
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
116
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
117 The third output file:
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
118
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
119 .. image:: ${static_path}/operation_icons/dwt_var_perClass.png
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
120
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
121 </help>
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
122
cb422b6f49d2 Imported from capsule None
devteam
parents:
diff changeset
123 </tool>