annotate galaxy-conf/PowerSpectrum.xml @ 25:b43c420a6135 draft default tip

Incorporate fix: https://github.com/timpalpant/java-genomics-toolkit/commit/9a6c61b7c6b8d85a1cd3f595eed657a537b85dc9
author timpalpant
date Sat, 09 Feb 2019 14:02:24 -0500
parents 9d56b5b85740
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
1 <tool id="PowerSpectrum" name="Compute the power spectrum" version="1.0.0">
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
2 <description>of data in a Wiggle file</description>
25
b43c420a6135 Incorporate fix: https://github.com/timpalpant/java-genomics-toolkit/commit/9a6c61b7c6b8d85a1cd3f595eed657a537b85dc9
timpalpant
parents: 20
diff changeset
3 <command interpreter="bash">galaxyToolRunner.sh ngs.PowerSpectrum -i $input -l $windows -m $max -o $output</command>
20
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
4 <inputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
5 <param format="bigwig,wig" name="input" type="data" label="Input data" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
6 <param format="bed,bedgraph,gff" name="windows" type="data" label="List of intervals" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
7 <param name="max" type="integer" value="40" label="Number of frequencies to output" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
8 </inputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
9 <outputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
10 <data format="tabular" name="output" />
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
11 </outputs>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
12
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
13 <help>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
14
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
15 This tool computes the power spectrum of intervals of sequencing data. For each interval provided, the normalized power spectrum is calculated, representing the relative power in each frequency. Power spectra are normalized to have total power 1, with the DC component (0 frequency) removed. Power spectra are computed using the FFT_ implementation in JTransforms_.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
16
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
17 .. _FFT: http://en.wikipedia.org/wiki/Fast_Fourier_transform
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
18
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
19 .. _JTransforms: http://sites.google.com/site/piotrwendykier/software/jtransforms
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
20
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
21 -----
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
22
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
23 **Syntax**
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
24
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
25 - **Input data** is the genomic data on which to compute the power spectrum.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
26 - **List of intervals:** The power spectrum will be computed for each genomic interval specified in this list.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
27 - **Number of frequencies:** The power spectrum will be truncated at this frequency in the output
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
28
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
29 -----
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
30
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
31 **Output**
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
32
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
33 The output has the following format ::
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
34
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
35 chr start stop id alignment strand freq1 freq2 ...
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
36
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
37 up to the maximum frequency specified. Frequencies are truncated to reduce the size of the output since signals are often band-limited.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
38
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
39 -----
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
40
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
41 .. class:: warningmark
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
42
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
43 **NOTE:** Even though frequencies may be truncated in the output, all frequencies in the power spectrum are computed and used for normalization.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
44
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
45 .. class:: infomark
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
46
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
47 **TIP:** If your dataset does not appear in the pulldown menu, it means that it is not in Wig or BigWig format. Use "edit attributes" to set the correct format if it was not detected correctly. Intervals must be provided in Bed, BedGraph, or GFF format.
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
48
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
49 -----
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
50
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
51 This tool is equivalent to the following Matlab commands, where x is a vector with the interval of sequencing data ::
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
52
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
53 N = length(x);
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
54 f = fft(x);
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
55 p = abs(f(2:N/2)).^2;
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
56 p = p / sum(p);
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
57
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
58 </help>
9d56b5b85740 Reuploaded to see if tools get loaded correctly this time.
timpalpant
parents:
diff changeset
59 </tool>