Mercurial > repos > timpalpant > java_genomics_toolkit

comparison galaxy-conf/Correlate.xml @ 24:a77e126ae856 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Reupload since last upload did not load correctly
author timpalpant
date Tue, 19 Jun 2012 22:15:09 -0400
parents 3e477c7e0e73
children b43c420a6135
comparison
equal deleted inserted replaced
23:01d5d20eaadd 24:a77e126ae856
1 <tool id="WigCorrelate" name="Correlate" version="1.1.0">
2 <description>multiple (Big)Wig files</description>
3 <command interpreter="sh">
4 galaxyToolRunner.sh wigmath.Correlate -w $window -s $step -t $type -o $output $file1 $file2
5 #for $input in $inputs
6 ${input.file}
7 #end for
8 </command>
9 <inputs>
10 <param name="file1" label="(Big)Wig file 1" type="data" format="bigwig,wig" />
11 <param name="file2" label="(Big)Wig file 2" type="data" format="bigwig,wig" />
12 <repeat name="inputs" title="Additional (Big)Wig file">
13 <param name="file" type="data" format="bigwig,wig" />
14 </repeat>
15 <param name="window" type="integer" value="100" label="Window size (bp)" />
16 <param name="step" type="integer" value="50" label="Sliding step size (bp)" />
17 <param name="type" type="select" label="Correlation metric">
18 <option value="pearson">Pearson</option>
19 <option value="spearman">Spearman</option>
20 </param>
21 </inputs>
22 <outputs>
23 <data format="tabular" name="output" />
24 </outputs>
25
26 <help>
27
28 This tool will compute a correlation matrix between the supplied Wig or BigWig files. Each row/column in the matrix is added in the order that files are added above, starting from the top left. The Wig file is downsampled into sliding windows with the specified bin size and shift by computing the mean value in each window. These windows are then correlated using either Pearson_'s Product-Moment correlation coefficient or Spearman_'s rank correlation coefficient. If the window size is set to 1, the correlation is calculated between all base pairs in the genome.
29
30 .. _Pearson: http://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient
31
32 .. _Spearman: http://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient
33
34 -----
35
36 **Syntax**
37
38 - **Inputs** are the genomic data to correlate
39 - **Window size** is the size of the window to bin data into
40 - **Sliding step size** is the shift step size of the sliding window used during binning
41 - **Correlation metric** is the type of correlation to calculate
42
43 -----
44
45 .. class:: warningmark
46
47 **WARN:** In order to calculate the correlation coefficient, the data is loaded into entirely into memory. For large genomes, this may require a lot of RAM unless comparably larger window sizes are used.
48
49 -----
50
51 **Citation**
52
53 This tool was inspired by ACT_ from the Gerstein lab.
54
55 .. _ACT: http://act.gersteinlab.org
56
57 J Jee*, J Rozowsky*, KY Yip*, L Lochovsky, R Bjornson, G Zhong, Z Zhang, Y Fu, J Wang, Z Weng, M Gerstein. ACT: Aggregation and Correlation Toolbox for Analyses of Genome Tracks. (2011) Bioinformatics 27(8): 1152-4.
58
59 </help>
60 </tool>