annotate bigwigCompare.xml @ 13:b4c5dd45778a draft

Uploaded
author bgruening
date Mon, 16 Dec 2013 04:36:19 -0500
parents 135f3bae5c56
children 5ea8782d650c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
135f3bae5c56 Uploaded
bgruening
parents: 9
diff changeset
1 <tool id="deeptools_bigwigCompare" name="bigwigCompare" version="1.0.2">
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"/>
10
135f3bae5c56 Uploaded
bgruening
parents: 9
diff changeset
4 <expand macro="stdio" />
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
5 <macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
6 <import>deepTools_macros.xml</import>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
7 </macros>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
8 <command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
9 bigwigCompare
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
10
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
11 @THREADS@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
12
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
13 --bigwig1 '$bigwigFile1'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
14 --bigwig2 '$bigwigFile2'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
15
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
16 --outFileName '$outFileName'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
17 --outFileFormat '$outFileFormat'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
18
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
19 --ratio $comparison_type
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
20
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
21 #if $advancedOpt.showAdvancedOpt == "yes":
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
22 #if str($advancedOpt.region.value) != '':
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
23 --region '$advancedOpt.region'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
24 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
25
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
26 --missingDataAsZero $advancedOpt.missingDataAsZero
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
27 --scaleFactors '$advancedOpt.scaleFactor1:$advancedOpt.scaleFactor2'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
28 --pseudocount '$advancedOpt.pseudocount'
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
29 --binSize $advancedOpt.binSize
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
30
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
31 #end if
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
32 </command>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
33 <inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
34 <param name="bigwigFile1" format="bigwig" type="data" label="Treatment bigwig file" />
9
c53a73b8eef9 Uploaded
bgruening
parents: 2
diff changeset
35 <param name="bigwigFile2" format="bigwig" type="data" label="bigWig file" />
0
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
36
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
37 <param name="comparison_type" type="select"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
38 label="How to compare the two files"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
39 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
40 <option value="log2" selected="true">log2 ratio</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
41 <option value="ratio">simple ratio</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
42 <option value="subtract">difference (subtract input from treatment)</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
43 <option value="add">sum</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
44 <option value="reciprocal_ratio">reciprocal ratio</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
45 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
46
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
47 <param name="outFileFormat" type="select" label="Coverage file format">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
48 <option value="bigwig" selected="true">bigwig</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
49 <option value="bedgraph">bedgraph</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
50 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
51
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
52 <conditional name="advancedOpt">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
53 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
54 <option value="no" selected="true">no</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
55 <option value="yes">yes</option>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
56 </param>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
57 <when value="no" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
58 <when value="yes">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
59 <param name="binSize" type="integer" value="50" min="1"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
60 label="Bin size in bp"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
61 help="Size of the bins in bp for the ouput of the bigwig/bedgraph file "/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
62
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
63 <param name="region" type="text" value=""
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
64 label="Region of the genome to limit the operation to"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
65 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
66
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
67 <param name="missingDataAsZero" type="boolean" truevalue="yes" falsevalue="no" checked="True"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
68 label ="Treat missing data as zero"
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
69 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
70
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
71 <param name="scaleFactor1" type="float" value="1" label="Scale factor for treatment"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
72 <param name="scaleFactor2" type="float" value="1" label="Scale factor for input"/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
73 <param name="pseudocount" type="float" value="1" label="Pseudocount" help="Small number to avoid dividing by zero."/>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
74 </when>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
75 </conditional>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
76 </inputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
77 <outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
78 <data format="bigwig" name="outFileName">
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
79 <change_format>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
80 <when input="outFileFormat" value="bigwig" format="bigwig" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
81 <when input="outFileFormat" value="bedgraph" format="bedgraph" />
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
82 </change_format>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
83 </data>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
84 </outputs>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
85
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
86 <help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
87
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
88 **What it does**
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
89
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
90 This tool compares two bigwig files based on the number of mapped reads. To
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
91 compare the bigwig files the genome is partitioned into bins of equal size,
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
92 then the number of reads found in each BAM file are counted for such bins and
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
93 finally a summarizing value is reported. This value can be the ratio of the
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
94 number of reads per bin, the log2 of the ratio, the sum or the difference.
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
95
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
96 -----
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
97
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
98 .. class:: infomark
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
99
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
100 @REFERENCES@
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
101
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
102 </help>
d957e25e18a3 Uploaded
bgruening
parents:
diff changeset
103 </tool>