Mercurial > repos > bgruening > deeptools_correct_gc_bias

annotate correctGCBias.xml @ 41:a2827c6ef23a 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 ac42d29c298c026aa0c53c9db2553087ebc86b97"
author bgruening
date Fri, 11 Feb 2022 09:39:19 +0000
parents c0f2eb6b567f
children ed1ecf92943e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
1 <tool id="deeptools_correct_gc_bias" name="correctGCBias" version="@WRAPPER_VERSION@.0">
33
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
2 <description>uses the output from computeGCBias to generate GC-corrected BAM/CRAM files</description>
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
3 <macros>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
4 <token name="@BINARY@">correctGCBias</token>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
5 <import>deepTools_macros.xml</import>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
6 </macros>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
7 <expand macro="requirements" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
8 <command>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
9 <![CDATA[
35
c0f2eb6b567f planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
10 ln -s '$bamInput' local_bamInput.bam &&
33
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
11 #if $bamInput.ext == 'bam':
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
12 ln -s '${bamInput.metadata.bam_index}' local_bamInput.bam.bai &&
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
13 #else:
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
14 ln -s '${bamInput.metadata.cram_index}' local_bamInput.bam.crai &&
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
15 #end if
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
16
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
17 @BINARY@
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
18 @THREADS@
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
19 --bamfile local_bamInput.bam
35
c0f2eb6b567f planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit 5a01e3a370130f32a82d5436504371ed95be1754
bgruening
parents: 33
diff changeset
20 --GCbiasFrequenciesFile '$GCbiasFrequenciesFile'
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
21
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
22 @reference_genome_source@
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
23
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
24 #if $effectiveGenomeSize.effectiveGenomeSize_opt == "specific":
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
25 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
26 #else:
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
27 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
28 #end if
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
29
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
30 #if str($region).strip() != '':
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
31 --region '$region'
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
32 #end if
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
33 --correctedFile corrected.bam
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
34 ]]>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
35 </command>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
36 <inputs>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
37 <param argument="--GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" help="" />
33
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
38 <param argument="--bamInput" format="bam,cram" type="data"
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
39 label="BAM/CRAM file" help="This should be same file that was used for computeGCbias." />
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
40 <expand macro="reference_genome_source" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
41 <expand macro="effectiveGenomeSize" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
42 <expand macro="region_limit_operation" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
43 </inputs>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
44 <outputs>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
45 <data format="bam" from_work_dir="corrected.bam" name="outFileName" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
46 </outputs>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
47 <tests>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
48 <test>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
49 <param name="GCbiasFrequenciesFile" value="computeGCBias_result1.tabular" ftype="tabular" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
50 <param name="bamInput" value="paired_chr2L.bam" ftype="bam" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
51 <param name="ref_source" value="history" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
52 <param name="input1" value="sequence.2bit" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
53 <param name="effectiveGenomeSize_opt" value="specific" />
25
bbaa1e884d6e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 0eeb2e1a184186ba5ac044136e71b943e2af0f09
bgruening
parents: 16
diff changeset
54 <param name="effectiveGenomeSize" value="10050" />
33
6a4bbd164a98 planemo upload for repository https://github.com/deeptools/deepTools/tree/master/galaxy/wrapper/ commit b1f975422b307927bbbe245d57609e9464d5d5c8-dirty
bgruening
parents: 25
diff changeset
55 <output name="outFileName" file="correctGCBias_result1.bam" ftype="bam" lines_diff="200" />
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
56 </test>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
57 </tests>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
58 <help>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
59 <![CDATA[
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
60
13
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
61 What it does
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
62 -------------
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
63
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
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
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-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.
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
66
13
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
67 See the description of ``computeGCBias`` to read up on the details of the GC bias assessment and correction method.
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
68
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
69
13
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
70 Output files
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
71 ----------------
0
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
72
13
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
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.
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
diff changeset
74
cbf06812f848 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 13910e1a5ebcfc740c1bc5e38fc676592ef44f11
bgruening
parents: 9
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
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
76
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
77 -----
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
78
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
79 @REFERENCES@
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
80 ]]>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
81 </help>
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
82 <expand macro="citations" />
670d7273471e planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit e1fd513c18e0d5b53071d99f539ac3509ced01aa-dirty
bgruening
parents:
diff changeset
83 </tool>