annotate Sambamba_merge.xml @ 0:305a4f796bd3 draft default tip

planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
author bgruening
date Mon, 10 Feb 2025 19:11:44 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
1 <tool id="sambamba_merge" name="Sambamba merge" version="@TOOL_VERSION@+galaxy@SUFFIX_VERSION@" profile="23.2" license="MIT">
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
2 <description>Merge several BAM files into one</description>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
3 <macros>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
4 <import>macros.xml</import>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
5 </macros>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
6 <expand macro="requirements"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
7 <command><![CDATA[
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
8 sambamba merge
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
9 -l $compression_level
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
10 '${output}'
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
11 #for $infile in $input_bam:
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
12 '${infile}'
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
13 #end for
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
14 --nthreads \${GALAXY_SLOTS:-8}
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
15 ]]></command>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
16 <inputs>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
17 <param name="input_bam" type="data" format="qname_sorted.bam,bam" multiple="true" label="Input BAM files to be merged" help="Please note that the sorting order of all input files must be the same"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
18 <param argument="--compression-level" type="integer" value="5" min="0" max="9" label="Level of compression for merged BAM file, number from 0 to 9"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
19 </inputs>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
20 <outputs>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
21 <data name="output" format_source="input_files"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
22 </outputs>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
23 <tests>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
24 <test expect_num_outputs="1">
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
25 <param name="input_bam" value="qname_sorted.bam,qname_sorted.bam"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
26 <param name="compression_level" value="5"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
27 <output name="output" file="qname_sorted_merged.bam" lines_diff="4"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
28 </test>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
29 <test expect_num_outputs="1">
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
30 <param name="input_bam" value="coordinate_sorted.bam,coordinate_sorted.bam"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
31 <param name="compression_level" value="5"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
32 <output name="output" file="coordinate_sorted_merged.bam" lines_diff="4"/>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
33 </test>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
34 </tests>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
35 <help>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
36 <![CDATA[
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
37
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
38 sambamba_merge is used to merge several sorted BAM files into one. The sorting order of all the files must be the same, and it is maintained in the output file.
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
39
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
40 SAM headers are merged automatically like in Picard merging tool.
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
41 ]]>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
42 </help>
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
43 <expand macro="citations" />
305a4f796bd3 planemo upload for repository https://github.com/biod/sambamba commit 99bb4ed496a9cce79ab0a7e613230cf63a44d9f9
bgruening
parents:
diff changeset
44 </tool>