annotate sam_to_bam.xml @ 10:157bab484e81 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 9c5a35ce695c3d134e41d8695487edd5f71ea33c
author iuc
date Sun, 08 Sep 2024 03:21:53 +0000
parents d83ad701f011
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
1 <tool id="sam_to_bam" name="SAM-to-BAM" version="2.1.2" profile="@PROFILE@">
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
2 <description>convert SAM to BAM</description>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
3
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
4 <macros>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
5 <import>macros.xml</import>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
6 </macros>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
7 <expand macro="requirements"/>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
8 <expand macro="stdio"/>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
9 <expand macro="version_command"/>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
10
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
11 <command><![CDATA[
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
12 @ADDTHREADS@
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
13 @ADDMEMORY@
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
14 @PREPARE_FASTA_IDX@
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
15
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
16 samtools view
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
17 -b
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
18 -@ \$addthreads
9
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
19 -t "\$reffai"
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
20 '$input' |
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
21
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
22 samtools sort
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
23 -O bam
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
24 -@ \$addthreads -m \$addmemory"M"
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
25 -o '$output1'
6
a832dc88e7dc "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit e2a10eeee8765ba6cf03847562e56cdaeaf4ba5c"
iuc
parents: 4
diff changeset
26 -T "\${TMPDIR:-.}"
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
27 ]]></command>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
28
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
29 <inputs>
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
30 <param name="input" type="data" format="sam" label="SAM file to convert"/>
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
31 <expand macro="mandatory_reference" argument="-t"/>
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
32 </inputs>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
33 <outputs>
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
34 <data name="output1" format="bam" label="${tool.name} on ${on_string}: converted BAM">
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
35 <actions>
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
36 <conditional name="addref_cond.addref_select">
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
37 <when value="cached">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
38 <action name="dbkey" type="metadata">
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
39 <option name="input" param_attribute="dbkey" type="from_param" />
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
40 </action>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
41 </when>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
42 <when value="history">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
43 <action name="dbkey" type="metadata">
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
44 <option name="addref_cond.ref" param_attribute="dbkey" type="from_param" />
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
45 </action>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
46 </when>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
47 </conditional>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
48 </actions>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
49 </data>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
50 </outputs>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
51 <tests>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
52 <test>
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
53 <param name="addref_select" value="history" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
54 <param name="ref" ftype="fasta" dbkey="equCab2" value="chr_m.fasta" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
55 <param name="input" ftype="sam" value="sam_to_bam_in1.sam" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
56 <output name="output1" ftype="bam" file="sam_to_bam_out1.bam" lines_diff="4"/>
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
57 </test>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
58 <test>
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
59 <param name="addref_select" value="cached" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
60 <param name="ref" value="equCab2chrM" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
61 <param name="input" ftype="sam" dbkey="equCab2" value="sam_to_bam_in1.sam" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
62 <output name="output1" ftype="bam" file="sam_to_bam_out2.bam" lines_diff="4"/>
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
63 </test>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
64 <test>
8
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
65 <param name="addref_select" value="history" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
66 <param name="ref" ftype="fasta" dbkey="equCab2" value="chr_m.fasta" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
67 <param name="input" ftype="sam" value="sam_to_bam_noheader_in2.sam" />
c701f5f96f32 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 0f75269223c0821c6c82acf98fde947d0f816f2b"
iuc
parents: 7
diff changeset
68 <output name="output1" ftype="bam" file="sam_to_bam_out3.bam" lines_diff="4"/>
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
69 </test>
9
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
70 <test>
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
71 <!-- Test direct use of bgzipped reference -->
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
72 <param name="addref_select" value="history" />
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
73 <param name="ref" ftype="fasta.gz" dbkey="equCab2" value="chr_m.bgzipped_fasta.gz" />
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
74 <param name="input" ftype="sam" value="sam_to_bam_noheader_in2.sam" />
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
75 <output name="output1" ftype="bam" file="sam_to_bam_out3.bam" lines_diff="4"/>
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
76 </test>
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
77 <test>
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
78 <!-- Test with simple gzipped reference, which requires decompression -->
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
79 <param name="addref_select" value="history" />
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
80 <param name="ref" ftype="fasta.gz" dbkey="equCab2" value="chr_m.fasta.gz" />
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
81 <param name="input" ftype="sam" value="sam_to_bam_noheader_in2.sam" />
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
82 <output name="output1" ftype="bam" file="sam_to_bam_out3.bam" lines_diff="4"/>
d83ad701f011 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit c5ded4208dd70e88596ddc725795a2401773f02d"
iuc
parents: 8
diff changeset
83 </test>
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
84 </tests>
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
85 <help><![CDATA[
0
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
86 **What it does**
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
87
4
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
88 Converts SAM dataset into its binary, BAM, representation using the ``samtools view`` and ``sort`` commands.
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
89 ]]></help>
4afb4a5f0924 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 2
diff changeset
90 <expand macro="citations"/>
0
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
91 </tool>