annotate artbio_bam_cleaning.xml @ 0:65d6d2b554b3 draft

"planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
author artbio
date Fri, 02 Oct 2020 00:17:33 +0000
parents
children b550841f568b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
1 <tool id="artbio_bam_cleaning" name="ARTbio bam cleaning" version="1.6+galaxy0">
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
2 <description>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
3 on flags and PCR Duplicates and MD recalibration
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
4 </description>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
5 <macros>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
6 <import>macro.xml</import>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
7 </macros>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
8 <requirements>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
9 <requirement type="package" version="1.6">samtools</requirement>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
10 <requirement type="package" version="0.7.1">sambamba</requirement>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
11 <requirement type="package" version="1.3.2">freebayes</requirement>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
12 </requirements>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
13 <stdio>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
14 <exit_code range="1:" level="fatal" description="Error occured" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
15 </stdio>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
16 <command detect_errors="exit_code"><![CDATA[
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
17 @pipefail@
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
18 @set_fasta_index@
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
19 #set input_base = 'input'
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
20 ln -f -s $input_bam.metadata.bam_index input.bam.bai &&
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
21 ln -s $input_bam input.bam &&
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
22 sambamba view -h -t 8 --filter='mapping_quality >= 1 and not(unmapped) and not(mate_is_unmapped)' -f 'bam' $input_base".bam"
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
23 | samtools rmdup - -
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
24 |tee $input_base".filt1.dedup.bam"| bamleftalign --fasta-reference reference.fa -c --max-iterations "5" -
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
25 | samtools calmd -C 50 -b -@ \${GALAXY_SLOTS:-2} - reference.fa > $input_base".filt1.dedup.bamleft.calmd.bam" &&
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
26 sambamba view -h -t 8 --filter='mapping_quality <= 254' -f 'bam' -o $input_base".filt1.dedup.bamleft.calmd.filt2.bam" $input_base".filt1.dedup.bamleft.calmd.bam"
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
27 ]]></command>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
28 <inputs>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
29 <expand macro="reference_source_conditional" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
30 <param name="input_bam" type="data" format="bam" label="BAM or SAM file to process"/>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
31 </inputs>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
32 <outputs>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
33 <data name="calmd" format="bam" label="CalMD filter (for lumpy-smoove)" from_work_dir="./input.filt1.dedup.bamleft.calmd.bam"/>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
34 <data name="fullfilter" format="bam" label="Full filtering (for somatic-varscan)" from_work_dir="./input.filt1.dedup.bamleft.calmd.filt2.bam"/>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
35 </outputs>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
36 <tests>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
37 <test>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
38 <param name="input_bam" value="match_chr21_DBA_974.bam" ftype="bam" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
39 <param name="reference_source_selector" value="history" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
40 <param name="ref_file" value="chr21.fa" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
41 <output name="calmd" file="match_chr21_DBA_974.filt1.dedup.bamleft.calmd.bam" ftype="bam" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
42 <output name="fullfilter" file="match_chr21_DBA_974.filt1.dedup.bamleft.calmd.filt2.bam" ftype="bam" />
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
43 </test>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
44 </tests>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
45 <help>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
46 ARTbio bam cleaning overview
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
47 ============================
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
48
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
49 This tool is wrapping several cleaning steps to produce bam files suitable for subsequent
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
50 analyses with lumpy-smoove (or other large structural variation callers) or with
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
51 somatic-varscan (or small structural variation callers)
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
52
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
53
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
54 Workflow
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
55 =============
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
56
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
57 The tool is using the following command line for filtering:
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
58
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
59 ::
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
60
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
61 sambamba view -h -t 8 --filter='mapping_quality >= 1 and not(unmapped) and not(mate_is_unmapped)' -f 'bam' $input_base".bam"
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
62 &#124; samtools rmdup - -
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
63 &#124;tee $input_base".filt1.dedup.bam" &#124; bamleftalign --fasta-reference reference.fa -c --max-iterations "5" -
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
64 &#124; samtools calmd -C 50 -b -@ 4 - reference.fa &gt; $input_base".filt1.dedup.bamleft.calmd.bam" ;
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
65 sambamba view -h -t 8 --filter='mapping_quality &lt;&#61; 254' -f 'bam' -o $input_base".filt1.dedup.bamleft.calmd.filt2.bam" $input_base".filt1.dedup.bamleft.calmd.bam"
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
66
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
67 Purpose
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
68 --------
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
69
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
70 This "workflow" tool was generated in order to limit the number of ``python metadata/set.py`` jobs
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
71 which occur at each step of standard galaxy workflows. Indeed, these jobs are poorly optimized and may last considerable
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
72 amounts of time when datasets are large, at each step, lowering the overall performance of the workflow.
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
73
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
74 </help>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
75 <citations>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
76 <citation type="doi">10.1371/journal.pone.0168397</citation>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
77 </citations>
65d6d2b554b3 "planemo upload for repository https://github.com/ARTbio/tools-artbio/tree/master/tools/artbio_bam_cleaning commit adfad19ff505ac7baa3688997bfa9f64243aaace"
artbio
parents:
diff changeset
78 </tool>