|
0
|
1 <tool id="deeptools_bigwigCompare" name="bigwigCompare" version="@WRAPPER_VERSION@.0">
|
|
|
2 <description>normalizes and compares two bigWig files to obtain the ratio, log2ratio or difference</description>
|
|
|
3 <expand macro="requirements"/>
|
|
|
4 <expand macro="stdio" />
|
|
|
5 <macros>
|
|
|
6 <token name="@BINARY@">bigwigCompare</token>
|
|
|
7 <import>deepTools_macros.xml</import>
|
|
|
8 </macros>
|
|
|
9 <command>
|
|
|
10 <![CDATA[
|
|
|
11 bigwigCompare
|
|
|
12
|
|
|
13 @THREADS@
|
|
|
14
|
|
|
15 --bigwig1 '$bigwigFile1'
|
|
|
16 --bigwig2 '$bigwigFile2'
|
|
|
17
|
|
|
18 --outFileName '$outFileName'
|
|
|
19 --outFileFormat '$outFileFormat'
|
|
|
20
|
|
|
21 --ratio $comparison.comparison_select
|
|
|
22
|
|
|
23 #if $comparison.comparison_select in ['ratio','log2']:
|
|
|
24 --pseudocount $comparison.pseudocount
|
|
|
25 #end if
|
|
|
26
|
|
|
27 #if str($region).strip() != '':
|
|
|
28 --region '$region'
|
|
|
29 #end if
|
|
|
30
|
|
|
31 #if $advancedOpt.showAdvancedOpt == "yes":
|
|
|
32
|
|
|
33 --missingDataAsZero $advancedOpt.missingDataAsZero
|
|
|
34 --scaleFactors '$advancedOpt.scaleFactor1:$advancedOpt.scaleFactor2'
|
|
|
35 --binSize $advancedOpt.binSize
|
|
|
36
|
|
|
37 #end if
|
|
|
38 ]]>
|
|
|
39 </command>
|
|
|
40 <inputs>
|
|
|
41 <param name="bigwigFile1" format="bigwig" type="data" label="Treatment bigwig file" />
|
|
|
42 <param name="bigwigFile2" format="bigwig" type="data" label="bigWig file" />
|
|
|
43
|
|
|
44 <conditional name="comparison">
|
|
|
45 <param name="comparison_select" type="select"
|
|
|
46 label="How to compare the two files" help="(--ratio)">
|
|
|
47 <option value="log2" selected="true">compute log2 of the number of reads ratio</option>
|
|
|
48 <option value="ratio">compute the ratio of the number of reads</option>
|
|
|
49 <option value="subtract">compute difference (subtract input from treatment) of the number of reads</option>
|
|
|
50 <option value="add">compute the sum over all reads</option>
|
|
|
51 <option value="reciprocal_ratio">compute the reciprocal ratio of the number of reads</option>
|
|
|
52 </param>
|
|
|
53 <when value="log2">
|
|
|
54 <expand macro="pseudocount" />
|
|
|
55 </when>
|
|
|
56 <when value="ratio">
|
|
|
57 <expand macro="pseudocount" />
|
|
|
58 </when>
|
|
|
59 <when value="subtract" />
|
|
|
60 <when value="add" />
|
|
|
61 <when value="reciprocal_ratio" />
|
|
|
62 </conditional>
|
|
|
63
|
|
|
64 <param name="outFileFormat" type="select" label="Coverage file format">
|
|
|
65 <option value="bigwig" selected="true">bigwig</option>
|
|
|
66 <option value="bedgraph">bedgraph</option>
|
|
|
67 </param>
|
|
|
68
|
|
|
69 <expand macro="region_limit_operation" />
|
|
|
70
|
|
|
71 <conditional name="advancedOpt">
|
|
|
72 <param name="showAdvancedOpt" type="select" label="Show advanced options" >
|
|
|
73 <option value="no" selected="true">no</option>
|
|
|
74 <option value="yes">yes</option>
|
|
|
75 </param>
|
|
|
76 <when value="no" />
|
|
|
77 <when value="yes">
|
|
|
78 <param name="binSize" type="integer" value="50" min="1"
|
|
|
79 label="Length, in base pairs, of the non-overlapping bin for averaging the score over the regions length"
|
|
|
80 help="Size of the bins in bp for the output of the bigwig/bedgraph file. (--binSize)"/>
|
|
|
81 <param name="missingDataAsZero" type="boolean" truevalue="yes" falsevalue="no" checked="True"
|
|
|
82 label ="Treat missing data as zero"
|
|
|
83 help ="This parameter determines if missing data should be replaced with a zero. If set to "no", 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. (--missingDataAsZero)" />
|
|
|
84 <expand macro="scaleFactor" />
|
|
|
85 </when>
|
|
|
86 </conditional>
|
|
|
87 </inputs>
|
|
|
88 <outputs>
|
|
|
89 <data format="bigwig" name="outFileName">
|
|
|
90 <change_format>
|
|
|
91 <when input="outFileFormat" value="bigwig" format="bigwig" />
|
|
|
92 <when input="outFileFormat" value="bedgraph" format="bedgraph" />
|
|
|
93 </change_format>
|
|
|
94 </data>
|
|
|
95 </outputs>
|
|
|
96 <tests>
|
|
|
97 <test>
|
|
|
98 <param name="bigwigFile1" value="1.bigwig" ftype="bigwig" />
|
|
|
99 <param name="bigwigFile2" value="1.bigwig" ftype="bigwig" />
|
|
|
100 <param name="showAdvancedOpt" value="no" />
|
|
|
101 <param name="outFileFormat" value="bigwig" />
|
|
|
102 <param name="binSize" value="5" />
|
|
|
103 <param name="comparison_select" value="ratio" />
|
|
|
104 <output name="outFileName" file="bigwigCompare_result1.bw" ftype="bigwig" />
|
|
|
105 </test>
|
|
|
106 <test>
|
|
|
107 <param name="bigwigFile1" value="1.bigwig" ftype="bigwig" />
|
|
|
108 <param name="bigwigFile2" value="1.bigwig" ftype="bigwig" />
|
|
|
109 <param name="showAdvancedOpt" value="no" />
|
|
|
110 <param name="outFileFormat" value="bedgraph" />
|
|
|
111 <param name="binSize" value="10" />
|
|
|
112 <param name="comparison_select" value="ratio" />
|
|
|
113 <output name="outFileName" file="bigwigCompare_result2.bg" ftype="bedgraph" />
|
|
|
114 </test>
|
|
|
115 </tests>
|
|
|
116 <help>
|
|
|
117 <![CDATA[
|
|
|
118 **What it does**
|
|
|
119
|
|
|
120 This tool compares two bigwig files based on the number of mapped reads. To
|
|
|
121 compare the bigwig files the genome is partitioned into bins of equal size,
|
|
|
122 then the number of reads found in each BAM file are counted for such bins and
|
|
|
123 finally a summarizing value is reported. This value can be the ratio of the
|
|
|
124 number of reads per bin, the log2 of the ratio, the sum or the difference.
|
|
|
125
|
|
|
126
|
|
|
127 -----
|
|
|
128
|
|
|
129 @REFERENCES@
|
|
|
130 ]]>
|
|
|
131 </help>
|
|
|
132 <expand macro="citations" />
|
|
|
133 </tool>
|
