annotate galaxy-conf/Correlate.xml @ 17:ace7855c1017 draft

Add back tool_data_table_conf.xml.sample since apparently it's still needed.
author timpalpant
date Sat, 09 Jun 2012 16:10:42 -0400
parents 3e477c7e0e73
children b43c420a6135
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
1 <tool id="WigCorrelate" name="Correlate" version="1.1.0">
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
2 <description>multiple (Big)Wig files</description>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
3 <command interpreter="sh">
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
4 galaxyToolRunner.sh wigmath.Correlate -w $window -s $step -t $type -o $output $file1 $file2
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
5 #for $input in $inputs
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
6 ${input.file}
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
7 #end for
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
8 </command>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
9 <inputs>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
10 <param name="file1" label="(Big)Wig file 1" type="data" format="bigwig,wig" />
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
11 <param name="file2" label="(Big)Wig file 2" type="data" format="bigwig,wig" />
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
12 <repeat name="inputs" title="Additional (Big)Wig file">
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
13 <param name="file" type="data" format="bigwig,wig" />
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
14 </repeat>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
15 <param name="window" type="integer" value="100" label="Window size (bp)" />
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
16 <param name="step" type="integer" value="50" label="Sliding step size (bp)" />
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
17 <param name="type" type="select" label="Correlation metric">
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
18 <option value="pearson">Pearson</option>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
19 <option value="spearman">Spearman</option>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
20 </param>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
21 </inputs>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
22 <outputs>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
23 <data format="tabular" name="output" />
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
24 </outputs>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
25
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
26 <help>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
27
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
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.
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
29
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
30 .. _Pearson: http://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
31
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
32 .. _Spearman: http://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
33
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
34 -----
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
35
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
36 **Syntax**
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
37
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
38 - **Inputs** are the genomic data to correlate
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
39 - **Window size** is the size of the window to bin data into
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
40 - **Sliding step size** is the shift step size of the sliding window used during binning
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
41 - **Correlation metric** is the type of correlation to calculate
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
42
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
43 -----
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
44
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
45 .. class:: warningmark
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
46
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
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.
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
48
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
49 -----
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
50
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
51 **Citation**
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
52
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
53 This tool was inspired by ACT_ from the Gerstein lab.
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
54
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
55 .. _ACT: http://act.gersteinlab.org
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
56
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
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.
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
58
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
59 </help>
3e477c7e0e73 Update normalization tools to allow normalizing by chromosome (Z-scorer, scale, etc.) Add new tool to convert any interval file to Bed format. Miscellaneous bug fixes.
timpalpant
parents:
diff changeset
60 </tool>