annotate execute_dwt_var_perFeature.xml @ 3:6c29c7e347e8 draft default tip

"planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
author devteam
date Mon, 06 Jul 2020 20:34:27 -0400
parents 7a15159140d1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
1 <tool id="dwt_var1" name="Wavelet variance" version="1.0.2">
2
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
2 <description>using Discrete Wavelet Transfoms</description>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
3 <requirements>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
4 <requirement type="package" version="1.0_6">r-bitops</requirement>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
5 <requirement type="package" version="1.7.5">r-waveslim</requirement>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
6 <requirement type="package" version="4.6.8">r-wavethresh</requirement>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
7 </requirements>
3
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
8 <command detect_errors="exit_code">
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
9 Rscript --vanilla '$__tool_directory__/execute_dwt_var_perFeature.R'
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
10 '$inputFile'
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
11 '$feature'
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
12 '$alpha'
2
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
13 '$outputFile1'
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
14 '$outputFile2'
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
15 </command>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
16 <inputs>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
17 <param format="tabular" name="inputFile" type="data" label="Select data"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
18 <param name="feature" label="Feature column" type="data_column" data_ref="inputFile" multiple="true"
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
19 help="Please select at least one column"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
20 <param name="alpha" type="float" value="0.05" label="alpha (significance level)" />
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
21 </inputs>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
22 <outputs>
3
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
23 <data format="tabular" name="outputFile1" label="${tool.name} on ${on_string}: statistics"/>
6c29c7e347e8 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 2
diff changeset
24 <data format="pdf" name="outputFile2" label="${tool.name} on ${on_string}: pdf"/>
2
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
25 </outputs>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
26 <tests>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
27 <test>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
28 <param name="inputFile" value="dwt_var_in.interval"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
29 <param name="feature" value="4"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
30 <param name="alpha" value="0.05"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
31 <output name="outputFile1" file="dwt_var_out1.tabular" compare="re_match"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
32 <output name="outputFile2" file="dwt_var_out2.pdf" compare="sim_size"/>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
33 </test>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
34 </tests>
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
35 <help>
0
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
36
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
37 .. class:: infomark
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
38
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
39 **What it does**
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
40
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
41 This tool computes the scale-specific variance in wavelet coeffients obtained from the discrete wavelet transform of a feature of interest.
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
42
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
43 Input data consists of an ordered series of data, S, equispaced and of sample size N, where N is of the form N = 2^k, and k is a positive integer and represents the number of levels of wavelet decomposition. S could be a time series, or a set of DNA sequences. The user calculates a statistic of interest for each feature in each interval of S: say, expression level of a particular gene in a time course, or the number of LINE elements per window across a chromosome. This tool then performs a discrete wavelet transform of the feature of interest, and plots the resulting variance in wavelet coefficients per wavelet scale. In addition, statistical significance of variances are determined by 1,000 random permutations of the intervals in S, to generate null bands (representing the user provided alpha value) corresponding to the empirical distribution of wavelet variances under the null hypothesis of no inherent order to the series in S.
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
44
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
45 This tool generates two output files:
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
46
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
47 - The first output file is a TABULAR format file representing the variances, p-values, and test orientation for the features at each wavelet scale based on a random permutation test.
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
48 - The second output file is a PDF image plotting the wavelet variances of each feature at each scale.
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
49
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
50 -----
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
51
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
52 .. class:: warningmark
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
53
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
54 **Note**
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
55 In order to obtain empirical p-values, a random perumtation scheme is implemented by the tool, such that the output may generate slightly variations in results each time it is run on the same input file.
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
56
2
7a15159140d1 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 1
diff changeset
57 </help>
0
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
58 </tool>