annotate bigwigCompare.xml @ 7:d63afb3521e7 draft

Uploaded
author bgruening
date Wed, 04 Dec 2013 04:13:19 -0500
parents b5da81864541
children c53a73b8eef9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
1 <tool id="deeptools_bigwigCompare" name="bigwigCompare" version="1.0">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
2 <description>normalizes and compares two bigWig files to obtain the ratio, log2ratio or difference</description>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
4 <macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
5 <import>deepTools_macros.xml</import>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
6 </macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
7 <command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
8 bigwigCompare
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
9
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
10 @THREADS@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
11
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
12 --bigwig1 '$bigwigFile1'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
13 --bigwig2 '$bigwigFile2'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
14
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
15 --outFileName '$outFileName'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
16 --outFileFormat '$outFileFormat'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
17
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
18 --ratio $comparison_type
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
19
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
20 #if $advancedOpt.showAdvancedOpt == "yes":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
21 #if str($advancedOpt.region.value) != '':
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
22 --region '$advancedOpt.region'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
23 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
24
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
25 --missingDataAsZero $advancedOpt.missingDataAsZero
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
26 --scaleFactors '$advancedOpt.scaleFactor1:$advancedOpt.scaleFactor2'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
27 --pseudocount '$advancedOpt.pseudocount'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
28 --binSize $advancedOpt.binSize
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
29
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
30 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
31 </command>
1
a22ccc261bb3 Uploaded
bgruening
parents: 0
diff changeset
32 <stdio>
a22ccc261bb3 Uploaded
bgruening
parents: 0
diff changeset
33 <regex match="Error:" />
a22ccc261bb3 Uploaded
bgruening
parents: 0
diff changeset
34 <regex match="EXception:" />
a22ccc261bb3 Uploaded
bgruening
parents: 0
diff changeset
35 </stdio>
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
36 <inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
37 <param name="bigwigFile1" format="bigwig" type="data" label="Treatment bigwig file" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
38 <param name="bigwigFile2" format="bigwig" type="data" label="Input bigwig file" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
39
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
40 <param name="comparison_type" type="select"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
41 label="How to compare the two files"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
42 help="The reciprocal ratio returns the negative of the inverse of the ratio if the ratio is less than 0. The resulting values are interpreted as negative fold changes." >
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
43 <option value="log2" selected="true">log2 ratio</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
44 <option value="ratio">simple ratio</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
45 <option value="subtract">difference (subtract input from treatment)</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
46 <option value="add">sum</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
47 <option value="reciprocal_ratio">reciprocal ratio</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
48 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
49
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
50 <param name="outFileFormat" type="select" label="Coverage file format">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
51 <option value="bigwig" selected="true">bigwig</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
52 <option value="bedgraph">bedgraph</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
53 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
54
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
55 <conditional name="advancedOpt">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
56 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
57 <option value="no" selected="true">no</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
58 <option value="yes">yes</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
59 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
60 <when value="no" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
61 <when value="yes">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
62 <param name="binSize" type="integer" value="50" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
63 label="Bin size in bp"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
64 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file "/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
65
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
66 <param name="region" type="text" value=""
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
67 label="Region of the genome to limit the operation to"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
68 help="This is useful when testing parameters to reduce the computing time. The format is chr:start:end, for example &quot;chr10&quot; or &quot;chr10:456700:891000&quot;" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
69
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
70 <param name="missingDataAsZero" type="boolean" truevalue="yes" falsevalue="no" checked="True"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
71 label ="Treat missing data as zero"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
72 help ="This parameter determines if missing data should be replaced with a zero. If set to &quot;no&quot;, missing data will be ignored and will not be included in the output file at all. Missing data is defined as those regions for which no value exists in *any* of the bigwig files. The decision to include or exclude missing data depends on the interpretation of the data. Missing data in a bigwig file may mean that there is no information available for certain regions, for example a repetitive region that is not being considered. In the same file regions with low coverage may get zero read counts. If missing data is replaced by zero, this would convert the excluded repetitive regions into regions of low coverage." />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
73
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
74 <param name="scaleFactor1" type="float" value="1" label="Scale factor for treatment"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
75 <param name="scaleFactor2" type="float" value="1" label="Scale factor for input"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
76 <param name="pseudocount" type="float" value="1" label="Pseudocount" help="Small number to avoid dividing by zero."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
77 </when>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
78 </conditional>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
79 </inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
80 <outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
81 <data format="bigwig" name="outFileName">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
82 <change_format>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
83 <when input="outFileFormat" value="bigwig" format="bigwig" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
84 <when input="outFileFormat" value="bedgraph" format="bedgraph" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
85 </change_format>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
86 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
87 </outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
88
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
89 <help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
90
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
91 **What it does**
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
92
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
93 This tool compares two bigwig files based on the number of mapped reads. To
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
94 compare the bigwig files the genome is partitioned into bins of equal size,
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
95 then the number of reads found in each BAM file are counted for such bins and
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
96 finally a summarizing value is reported. This value can be the ratio of the
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
97 number of reads per bin, the log2 of the ratio, the sum or the difference.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
98
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
99 -----
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
100
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
101 .. class:: infomark
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
102
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
103 @REFERENCES@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
104
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
105 </help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
106 </tool>