annotate execute_dwt_var_perFeature.xml @ 0:d56c5d2e1a29 draft

Imported from capsule None
author devteam
date Mon, 27 Jan 2014 09:26:33 -0500
parents
children cb1c59d69557
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="dwt_var1" name="Wavelet variance" version="1.0.0">
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
2 <description>using Discrete Wavelet Transfoms</description>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
3
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
4 <command interpreter="perl">
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
5 execute_dwt_var_perFeature.pl $inputFile $feature $alpha $outputFile1 $outputFile2
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
6 </command>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
7
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
8 <inputs>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
9 <param format="tabular" name="inputFile" type="data" label="Select data"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
10 <param name="feature" label="Feature column" type="data_column" data_ref="inputFile" multiple="true" help="Please select at least one column"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
11 <param name="alpha" size="10" type="float" value="0.05" label="alpha (significance level)" />
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
12 </inputs>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
13
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
14 <outputs>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
15 <data format="tabular" name="outputFile1"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
16 <data format="pdf" name="outputFile2"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
17 </outputs>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
18 <tests>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
19 <test>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
20 <param name="inputFile" value="discreteWavelet/dwt_var1/dwt_var_in.interval"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
21 <param name="feature" value="4"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
22 <param name="alpha" value="0.05"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
23 <output name="outputFile1" file="discreteWavelet/dwt_var1/dwt_var_out1.tabular" compare="re_match"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
24 <output name="outputFile2" file="discreteWavelet/dwt_var1/dwt_var_out2.pdf" compare="sim_size"/>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
25 </test>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
26 </tests>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
27
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
28 <help>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
29
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
30 .. class:: infomark
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
31
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
32 **What it does**
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
33
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
34 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
35
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
36 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
37
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
38 This tool generates two output files:
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
39
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
40 - 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
41 - 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
42
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
43 -----
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
44
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
45 .. class:: warningmark
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
46
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
47 **Note**
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
48 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
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
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
53 **Example**
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
54
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
55 </help>
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
56
d56c5d2e1a29 Imported from capsule None
devteam
parents:
diff changeset
57 </tool>