annotate correctGCBias.xml @ 110:fa6ef7619bbd draft default tip

Uploaded
author bgruening
date Mon, 26 Jan 2015 13:10:16 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
110
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
1 <tool id="deeptools_correctGCBias" name="correctGCBias" version="@WRAPPER_VERSION@.0">
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
2 <description>uses the output from computeGCBias to generate corrected BAM files</description>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
3 <expand macro="requirements" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
4 <expand macro="stdio" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
5 <macros>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
6 <token name="@BINARY@">correctGCBias</token>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
7 <import>deepTools_macros.xml</import>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
8 </macros>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
9 <command>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
10 <![CDATA[
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
11 ln -s $bamInput local_bamInput.bam;
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
12 ln -s $bamInput.metadata.bam_index local_bamInput.bam.bai;
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
13
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
14 correctGCBias
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
15 @THREADS@
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
16 --bamfile local_bamInput.bam
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
17 --GCbiasFrequenciesFile $GCbiasFrequenciesFile
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
18
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
19 @reference_genome_source@
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
20
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
21 #if $effectiveGenomeSize.effectiveGenomeSize_opt == "specific":
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
22 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
23 #else:
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
24 --effectiveGenomeSize $effectiveGenomeSize.effectiveGenomeSize_opt
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
25 #end if
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
26
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
27 #if str($region).strip() != '':
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
28 --region '$region'
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
29 #end if
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
30 --correctedFile $outFileName
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
31 ]]>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
32 </command>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
33 <inputs>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
34 <param name="GCbiasFrequenciesFile" type="data" format="tabular" label="Output of computeGCBias" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
35 <param name="bamInput" format="bam" type="data"
fa6ef7619bbd 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."/>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
37 <expand macro="reference_genome_source" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
38 <expand macro="effectiveGenomeSize" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
39 <expand macro="region_limit_operation" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
40 </inputs>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
41 <outputs>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
42 <data format="bam" name="outFileName" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
43 </outputs>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
44 <tests>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
45 <test>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
46 <param name="GCbiasFrequenciesFile" value="computeGCBias_result1.tabular" ftype="tabular" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
47 <param name="bamInput" value="phiX.bam" ftype="bam" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
48 <param name="ref_source" value="history" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
49 <param name="input1" value="phiX.2bit" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
50 <param name="effectiveGenomeSize_opt" value="specific" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
51 <param name="effectiveGenomeSize" value="5386" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
52 <output name="outFileName" file="correctGCBias_result1.bam" ftype="bam" compare="sim_size" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
53 </test>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
54 </tests>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
55 <help>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
56 <![CDATA[
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
57 **What it does**
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
58
fa6ef7619bbd 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
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
60 Benjamini and Speed (2012) Nucleic Acids Res.
fa6ef7619bbd 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.
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
62
fa6ef7619bbd 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
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
64
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
65
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
66 **Output files**:
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
67
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
68 - GC-normalized BAM file
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
69
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
70 -----
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
71
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
72 @REFERENCES@
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
73 ]]>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
74 </help>
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
75 <expand macro="citations" />
fa6ef7619bbd Uploaded
bgruening
parents:
diff changeset
76 </tool>