Mercurial > repos > bgruening > deeptools_correct_gc_bias

annotate correctGCBias.xml @ 22:ff570ee80712 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 6507b14607984c6f48d9866922a17132de4bb54d
author bgruening
date Tue, 19 Feb 2019 10:02:23 -0500
parents 9e60bf557373
children 5bffaa8354a1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
1 <tool id="deeptools_correct_gc_bias" name="correctGCBias" version="@WRAPPER_VERSION@.0">
17
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
2 <description>uses the output from computeGCBias to generate GC-corrected BAM/CRAM files</description>
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
3 <macros>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
4 <token name="@BINARY@">correctGCBias</token>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
5 <import>deepTools_macros.xml</import>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
6 </macros>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
8 <command>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
9 <![CDATA[
19
9e60bf557373 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 17
diff changeset
10 ln -s '$bamInput' local_bamInput.bam &&
17
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
11 #if $bamInput.ext == 'bam':
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
12 ln -s '${bamInput.metadata.bam_index}' local_bamInput.bam.bai &&
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
13 #else:
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
14 ln -s '${bamInput.metadata.cram_index}' local_bamInput.bam.crai &&
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
15 #end if
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
16
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
17 @BINARY@
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
18 @THREADS@
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
19 --bamfile local_bamInput.bam
19
9e60bf557373 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 17
diff changeset
20 --GCbiasFrequenciesFile '$GCbiasFrequenciesFile'
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
21
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
22 @reference_genome_source@
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
23
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
24 #if $effectiveGenomeSize.effectiveGenomeSize_opt == "specific":
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
25 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
26 #else:
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
27 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
28 #end if
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
29
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
30 #if str($region).strip() != '':
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
31 --region '$region'
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
32 #end if
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
33 --correctedFile corrected.bam
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
34 ]]>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
35 </command>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
36 <inputs>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
37 <param argument="--GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" help="" />
17
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
38 <param argument="--bamInput" format="bam,cram" type="data"
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
39 label="BAM/CRAM file" help="This should be same file that was used for computeGCbias." />
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
40 <expand macro="reference_genome_source" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
41 <expand macro="effectiveGenomeSize" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
42 <expand macro="region_limit_operation" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
43 </inputs>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
44 <outputs>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
45 <data format="bam" from_work_dir="corrected.bam" name="outFileName" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
46 </outputs>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
47 <tests>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
48 <test>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
49 <param name="GCbiasFrequenciesFile" value="computeGCBias_result1.tabular" ftype="tabular" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
50 <param name="bamInput" value="paired_chr2L.bam" ftype="bam" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
51 <param name="ref_source" value="history" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
52 <param name="input1" value="sequence.2bit" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
53 <param name="effectiveGenomeSize_opt" value="specific" />
10
297bccb7d5c6 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0eeb2e1a184186ba5ac044136e71b943e2af0f09
bgruening
parents: 3
diff changeset
54 <param name="effectiveGenomeSize" value="10050" />
17
3f84770b69cd planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 10
diff changeset
55 <output name="outFileName" file="correctGCBias_result1.bam" ftype="bam" lines_diff="200" />
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
56 </test>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
57 </tests>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
58 <help>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
59 <![CDATA[
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
60
1
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
61 What it does
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
62 -------------
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
63
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
64 This tool requires the output from computeGCBias to correct a given BAM file according to the method proposed in Benjamini and Speed (2012) Nucleic Acids Res. It will simply remove reads from regions with too high coverage compared to the expected values (typically GC-rich regions) and will add reads to regions where too few reads are seen (typically AT-rich regions).
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
65 The resulting BAM file can be used in any downstream analyses, but be aware that you should not filter out duplicates from here on.
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
66
1
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
67 See the description of ``computeGCBias`` to read up on the details of the GC bias assessment and correction method.
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
68
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
69
1
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
70 Output files
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
71 ----------------
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
72
1
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
73 ``correctGCbias`` only has one output: a BAM file where read densities have been changed to reflect the expected read distribution based on the genome.
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
74
4930eb430843 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit fef8b344925620444d93d8159c0b2731a5777920
bgruening
parents: 0
diff changeset
75 **Warning!** The GC-corrected BAM file will most likely contain several duplicated reads in regions where the coverage had to increased in order to match the expected read density. This means that you should absolutely avoid using any filtering of duplicate reads during your downstream analyses!
0
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
76
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
77 -----
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
78
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
79 @REFERENCES@
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
80 ]]>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
81 </help>
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
82 <expand macro="citations" />
748076af9837 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0a9265a12a303b54cdaa974e82e87c2ac60962ee-dirty
bgruening
parents:
diff changeset
83 </tool>