annotate sam_to_bam.xml @ 8:f7a0d41036c7 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
author iuc
date Tue, 09 May 2017 11:19:23 -0400
parents 881e16ad05c6
children cf1ffd88f895
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
1 <tool id="sam_to_bam" name="SAM-to-BAM" version="2.1.1">
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
2 <description>convert SAM to BAM</description>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
3
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
4 <macros>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
5 <import>macros.xml</import>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
6 </macros>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
7 <expand macro="requirements"/>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
8 <expand macro="stdio"/>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
9 <expand macro="version_command"/>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
10
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
11 <command><![CDATA[
7
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
12 #if $source.index_source == "history":
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
13 ln -s '${source.ref_file}' input.fa &&
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
14 samtools faidx input.fa &&
7
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
15 #else
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
16 ln -s '${source.index.fields.path}' input.fa &&
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
17 ln -s '${source.index.fields.path}.fai' input.fa.fai &&
7
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
18 #end if
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
19
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
20 samtools view
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
21 -b
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
22 -@ \${GALAXY_SLOTS:-1}
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
23 -t input.fa.fai '$input1' |
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
24
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
25 samtools sort
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
26 -O bam
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
27 -@ \${GALAXY_SLOTS:-1}
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
28 -o '$output1'
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
29 -T temp
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
30 ]]></command>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
31
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
32 <inputs>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
33 <conditional name="source">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
34 <param label="Choose the source for the reference genome" name="index_source" type="select">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
35 <option value="cached">Use a built-in genome</option>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
36 <option value="history">Use a genome from the history</option>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
37 </param>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
38 <when value="cached">
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
39 <param name="input1" type="data" format="sam" label="SAM file to convert">
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
40 <validator type="unspecified_build" />
d04d9f1c6791 Uploaded
devteam
parents: 5
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" />
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
42 </param>
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
43 <param name="index" type="select" label="Using reference genome">
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
44 <options from_data_table="fasta_indexes">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
45 <filter column="1" key="dbkey" ref="input1" type="data_meta" />
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
46 <validator message="No reference genome is available for the build associated with the selected input dataset" type="no_options" />
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
47 </options>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
48 </param>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
49 </when>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
50 <when value="history">
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
51 <param name="input1" type="data" format="sam" label="SAM file to convert" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
52 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
53 </when>
0
30fdbaccb96b Uploaded tool tarball.
devteam
parents:
diff changeset
54 </conditional>
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
55 </inputs>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
56 <outputs>
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
57 <data name="output1" format="bam" label="${tool.name} on ${on_string}: converted BAM">
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
58 <actions>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
59 <conditional name="source.index_source">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
60 <when value="cached">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
61 <action name="dbkey" type="metadata">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
62 <option name="source.input1" param_attribute="dbkey" type="from_param" />
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
63 </action>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
64 </when>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
65 <when value="history">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
66 <action name="dbkey" type="metadata">
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
67 <option name="source.ref_file" param_attribute="dbkey" type="from_param" />
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
68 </action>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
69 </when>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
70 </conditional>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
71 </actions>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
72 </data>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
73 </outputs>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
74 <tests>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
75 <test>
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
76 <param name="index_source" value="history" />
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
77 <param name="input1" ftype="sam" value="sam_to_bam_in1.sam" />
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
78 <param name="ref_file" ftype="fasta" dbkey="equCab2" value="chr_m.fasta" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
79 <output name="output1" ftype="bam" file="sam_to_bam_out1.bam" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
80 </test>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
81 <test>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
82 <param name="index_source" value="cached" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
83 <param name="input1" ftype="sam" dbkey="equCab2" value="sam_to_bam_in1.sam" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
84 <param name="index" value="equCab2chrM" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
85 <output name="output1" ftype="bam" file="sam_to_bam_out2.bam" />
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
86 </test>
7
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
87 <test>
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
88 <param name="index_source" value="history" />
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
89 <param name="input1" ftype="sam" value="sam_to_bam_noheader_in2.sam" />
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
90 <param name="ref_file" ftype="fasta" dbkey="equCab2" value="chr_m.fasta" />
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
91 <output name="output1" ftype="bam" file="sam_to_bam_out3.bam" />
7
881e16ad05c6 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/samtools/sam_to_bam commit a1517c9d22029095120643bbe2c8fa53754dd2b7
devteam
parents: 6
diff changeset
92 </test>
6
d04d9f1c6791 Uploaded
devteam
parents: 5
diff changeset
93 </tests>
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
94 <help><![CDATA[
0
30fdbaccb96b Uploaded tool tarball.
devteam
parents:
diff changeset
95 **What it does**
30fdbaccb96b Uploaded tool tarball.
devteam
parents:
diff changeset
96
8
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
97 Converts SAM dataset into its binary, BAM, representation using the ``samtools view`` and ``sort`` commands.
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
98 ]]></help>
f7a0d41036c7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/sam_to_bam commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 7
diff changeset
99 <expand macro="citations"/>
0
30fdbaccb96b Uploaded tool tarball.
devteam
parents:
diff changeset
100 </tool>