annotate execute_dwt_var_perFeature.xml @ 3:93b71985efd6 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/dwt_var_perfeature commit a684fffd461eea5ec33fe806fd2b6052c4321dcc
author devteam
date Tue, 14 Aug 2018 10:31:53 -0400
parents bf8d1e831816
children e6e495fa6a79
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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
1 <tool id="dwt_var1" name="Wavelet variance" version="1.0.1">
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="5.26.2.1">perl</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="3.4.1">r-base</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="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
7 <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
8 <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
9 <requirement type="package" version="2.4_5">r-rwave</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
10 </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
11 <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
12 perl '$__tool_directory__/execute_dwt_var_perFeature.pl'
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 '$inputFile'
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 $feature
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 $alpha
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 '$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
17 '$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
18 </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
19 <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
20 <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
21 <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
22 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
23 <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
24 </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
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 <data format="tabular" name="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
27 <data format="pdf" name="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
28 </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
29 <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
30 <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
31 <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
32 <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
33 <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
34 <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
35 <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
36 </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
37 </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
38 <help>
0
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
39
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
40 .. class:: infomark
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
41
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
42 **What it does**
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
43
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
44 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
45
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
46 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
47
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
48 This tool generates two output files:
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
49
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
50 - 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
51 - 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
52
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
53 -----
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
54
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
55 .. class:: warningmark
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
56
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
57 **Note**
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
58 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
59
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
60 </help>
0
083bf4961ff1 Imported from capsule None
devteam
parents:
diff changeset
61 </tool>