annotate correctGCBias.xml @ 31:7889d260cc37 draft default tip

planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
author bgruening
date Wed, 21 Oct 2015 02:50:24 -0400
parents 5231f398d784
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28
f7712a057440 new bugfix release
bgruening
parents: 27
diff changeset
1 <tool id="deeptools_correctGCBias" name="correctGCBias" version="@WRAPPER_VERSION@.0">
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
2 <description>uses the output from computeGCBias to generate corrected BAM files</description>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
3 <macros>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
4 <token name="@BINARY@">correctGCBias</token>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
5 <import>deepTools_macros.xml</import>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
6 </macros>
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
7 <expand macro="requirements" />
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
8 <command>
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
9 <![CDATA[
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
10 ln -s $bamInput local_bamInput.bam;
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
11 ln -s $bamInput.metadata.bam_index local_bamInput.bam.bai;
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
12
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
13 correctGCBias
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
14 @THREADS@
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
15 --bamfile local_bamInput.bam
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
16 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
17
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
18 @reference_genome_source@
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
19
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
20 #if $effectiveGenomeSize.effectiveGenomeSize_opt == "specific":
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
21 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
22 #else:
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
23 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
24 #end if
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
25
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
26 #if str($region).strip() != '':
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
27 --region '$region'
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
28 #end if
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
29 --correctedFile corrected.bam;
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
30
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
31 mv corrected.bam $outFileName;
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
32 ]]>
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
33 </command>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
34 <inputs>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
35 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
36 <param name="bamInput" format="bam" type="data"
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
37 label="BAM file" help="This should be same file that was used for computeGCbias. The BAM file must be sorted. (--bamfile)" />
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
38 <expand macro="reference_genome_source" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
39 <expand macro="effectiveGenomeSize" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
40 <expand macro="region_limit_operation" />
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
41 </inputs>
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
42 <outputs>
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
43 <data format="bam" name="outFileName" />
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
44 </outputs>
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
45 <tests>
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
46 <test>
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
47 <param name="GCbiasFrequenciesFile" value="computeGCBias_result1.tabular" ftype="tabular" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
48 <param name="bamInput" value="paired_chr2L.bam" ftype="bam" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
49 <param name="ref_source" value="history" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
50 <param name="input1" value="sequence.2bit" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
51 <param name="effectiveGenomeSize_opt" value="specific" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
52 <param name="effectiveGenomeSize" value="23011544" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
53 <output name="outFileName" file="correctGCBias_result1.bam" ftype="bam" />
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
54 </test>
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
55 </tests>
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
56 <help>
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
57 <![CDATA[
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
58 **What it does**
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
59
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
60 This tool requires the output from computeGCBias to correct a given BAM file according to the method proposed by
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
61 Benjamini and Speed (2012) Nucleic Acids Res.
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
62 The resulting BAM file can be used in any downstream analyses, but be aware that you should not filter out duplicates from here on.
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
63
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
64 You can find more details on the correctGCBias wiki page: https://github.com/fidelram/deepTools/wiki/QC#wiki-correctGCbias
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
65
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
66
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
67 **Output files**:
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
68
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
69 - GC-normalized BAM file
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
70
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
71 -----
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
72
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
73 @REFERENCES@
30
5231f398d784 planemo upload for repository https://github.com/fidelram/deepTools/tree/master/galaxy/wrapper/ commit 3bc1d1c6f4e28ac7ff8df79fe4e3f00a195938e6-dirty
bgruening
parents: 29
diff changeset
74 ]]>
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
75 </help>
29
3a2aab18a217 Uploaded
bgruening
parents: 28
diff changeset
76 <expand macro="citations" />
26
2ad3b027dfcd Uploaded
bgruening
parents:
diff changeset
77 </tool>