annotate correctGCBias.xml @ 0:b2886915ce68 draft default tip

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