annotate execute_dwt_var_perFeature.xml @ 4:e6e495fa6a79 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 18:13:13 +0000
parents 93b71985efd6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
1 <tool id="dwt_var1" name="Wavelet variance" version="1.0.2">
3
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
2 <description>using Discrete Wavelet Transfoms</description>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
3 <requirements>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
4 <requirement type="package" version="1.0_6">r-bitops</requirement>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
5 <requirement type="package" version="1.7.5">r-waveslim</requirement>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
6 <requirement type="package" version="4.6.8">r-wavethresh</requirement>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
7 </requirements>
4
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
8 <command detect_errors="exit_code">
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
9 Rscript --vanilla '$__tool_directory__/execute_dwt_var_perFeature.R'
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
10 '$inputFile'
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
11 '$feature'
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
12 '$alpha'
3
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
13 '$outputFile1'
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
14 '$outputFile2'
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
15 </command>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
16 <inputs>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
17 <param format="tabular" name="inputFile" type="data" label="Select data"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
18 <param name="feature" label="Feature column" type="data_column" data_ref="inputFile" multiple="true"
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
19 help="Please select at least one column"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
20 <param name="alpha" type="float" value="0.05" label="alpha (significance level)" />
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
21 </inputs>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
22 <outputs>
4
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
23 <data format="tabular" name="outputFile1" label="${tool.name} on ${on_string}: statistics"/>
e6e495fa6a79 "planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit f929353ffb0623f2218d7dec459c7da62f3b0d24"
devteam
parents: 3
diff changeset
24 <data format="pdf" name="outputFile2" label="${tool.name} on ${on_string}: pdf"/>
3
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
25 </outputs>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
26 <tests>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
27 <test>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
28 <param name="inputFile" value="dwt_var_in.interval"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
29 <param name="feature" value="4"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
30 <param name="alpha" value="0.05"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
31 <output name="outputFile1" file="dwt_var_out1.tabular" compare="re_match"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
32 <output name="outputFile2" file="dwt_var_out2.pdf" compare="sim_size"/>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
33 </test>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
34 </tests>
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
35 <help>
0
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
36
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
37 .. class:: infomark
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
38
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
39 **What it does**
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
40
083bf4961ff1 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.
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
42
083bf4961ff1 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.
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
44
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
45 This tool generates two output files:
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
46
083bf4961ff1 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.
083bf4961ff1 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.
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
49
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
50 -----
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
51
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
52 .. class:: warningmark
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
53
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
54 **Note**
083bf4961ff1 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.
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
56
3
93b71985efd6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
devteam
parents: 2
diff changeset
57 </help>
0
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
58 </tool>