annotate sam_to_bam.xml @ 7:428d5c102c96 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 95fe80d08fb14c4c344da4979290e72261e31ae5"
author iuc
date Thu, 10 Oct 2019 03:39:03 -0400
parents a832dc88e7dc
children c701f5f96f32
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
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
1 <tool id="sam_to_bam" name="SAM-to-BAM" version="2.1.1">
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[
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
12 #if $source.index_source == "history":
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
13 ln -s '${source.ref_file}' input.fa &&
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
14 samtools faidx input.fa &&
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
15 #else
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
16 ln -s '${source.index.fields.path}' input.fa &&
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 ln -s '${source.index.fields.path}.fai' input.fa.fai &&
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
18 #end if
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
19
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
20 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
21 -b
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 -@ \${GALAXY_SLOTS:-1}
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 -t input.fa.fai '$input1' |
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
24
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 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
26 -O bam
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 -@ \${GALAXY_SLOTS:-1}
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 -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
29 -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
30 ]]></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
31
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
32 <inputs>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
33 <conditional name="source">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
34 <param label="Choose the source for the reference genome" name="index_source" type="select">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
35 <option value="cached">Use a built-in genome</option>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
36 <option value="history">Use a genome from the history</option>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
37 </param>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
38 <when value="cached">
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
39 <param name="input1" type="data" format="sam" label="SAM file to convert">
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
40 <validator type="unspecified_build" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
41 <validator message="Sequences are not currently available for the specified build." metadata_column="1" metadata_name="dbkey" table_name="fasta_indexes" type="dataset_metadata_in_data_table" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
42 </param>
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
43 <param name="index" type="select" label="Using reference genome">
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
44 <options from_data_table="fasta_indexes">
7
428d5c102c96 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 95fe80d08fb14c4c344da4979290e72261e31ae5"
iuc
parents: 6
diff changeset
45 <filter column="dbkey" key="dbkey" ref="input1" type="data_meta" />
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
46 <validator message="No reference genome is available for the build associated with the selected input dataset" type="no_options" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
47 </options>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
48 </param>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
49 </when>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
50 <when value="history">
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
51 <param name="input1" type="data" format="sam" label="SAM file to convert" />
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
52 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
53 </when>
0
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
54 </conditional>
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
55 </inputs>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
56 <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
57 <data name="output1" format="bam" label="${tool.name} on ${on_string}: converted BAM">
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
58 <actions>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
59 <conditional name="source.index_source">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
60 <when value="cached">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
61 <action name="dbkey" type="metadata">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
62 <option name="source.input1" param_attribute="dbkey" type="from_param" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
63 </action>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
64 </when>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
65 <when value="history">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
66 <action name="dbkey" type="metadata">
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
67 <option name="source.ref_file" param_attribute="dbkey" type="from_param" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
68 </action>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
69 </when>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
70 </conditional>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
71 </actions>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
72 </data>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
73 </outputs>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
74 <tests>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
75 <test>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
76 <param name="index_source" value="history" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
77 <param name="input1" ftype="sam" value="sam_to_bam_in1.sam" />
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
78 <param name="ref_file" ftype="fasta" dbkey="equCab2" value="chr_m.fasta" />
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
79 <output name="output1" ftype="bam" file="sam_to_bam_out1.bam" />
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
80 </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
81 <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
82 <param name="index_source" value="cached" />
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
83 <param name="input1" ftype="sam" dbkey="equCab2" value="sam_to_bam_in1.sam" />
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
84 <param name="index" value="equCab2chrM" />
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 <output name="output1" ftype="bam" file="sam_to_bam_out2.bam" />
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
86 </test>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
87 <test>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
88 <param name="index_source" value="history" />
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
89 <param name="input1" ftype="sam" value="sam_to_bam_noheader_in2.sam" />
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
90 <param name="ref_file" ftype="fasta" dbkey="equCab2" value="chr_m.fasta" />
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
91 <output name="output1" ftype="bam" file="sam_to_bam_out3.bam" />
2
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
92 </test>
5a5f92086188 planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
93 </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
94 <help><![CDATA[
0
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
95 **What it does**
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
96
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
97 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
98 ]]></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
99 <expand macro="citations"/>
0
d59a7ac34414 Uploaded tool tarball.
devteam
parents:
diff changeset
100 </tool>