Mercurial > repos > devteam > samtools_sort

annotate samtools_sort.xml @ 11:797e773f1c3f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
author iuc
date Sun, 28 Jul 2019 14:50:11 -0400
parents c15c63771494
children 0149126ce6af
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
797e773f1c3f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 10
diff changeset
1 <tool id="samtools_sort" name="Samtools sort" version="2.0.2">
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
2 <description>order of storing aligned sequences</description>
6
191cec7b989b planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 5
diff changeset
3 <macros>
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
4 <import>macros.xml</import>
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
5 </macros>
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
6 <expand macro="requirements"/>
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
7 <expand macro="stdio"/>
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
8 <expand macro="version_command"/>
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
9 <command><![CDATA[
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
10 @ADDTHREADS@
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
11 @ADDMEMORY@
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
12 samtools sort
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
13 -@ \$addthreads
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
14 -m \$addmemory"M"
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
15 ###if str(compression):
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
16 ## -l '$compression'
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
17 ###end if
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
18 $prim_key_cond.prim_key_select
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
19 #if $prim_key_cond.prim_key_select == '-t':
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
20 $prim_key_cond.tag
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
21 $prim_key_cond.sec_key_select
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
22 #end if
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
23 -O bam
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
24 -T sorttmp
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
25 '${input1}'
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
26 > '${output1}'
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
27 ]]></command>
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
28 <inputs>
11
797e773f1c3f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit a972815cbd43dea553b3c0e4ad548f35d0023228-dirty
iuc
parents: 10
diff changeset
29 <param name="input1" type="data" format="sam,bam,cram" label="BAM File" />
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
30 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
31 <param name="prim_key_select" type="select" label="Primary sort key">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
32 <option value="">coordinate</option>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
33 <option value="-n">name (-n)</option>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
34 <option value="-t">tag (-t)</option>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
35 </param>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
36 <when value=""/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
37 <when value="-n"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
38 <when value="-t">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
39 <param name="tag" type="text" optional="false" argument="-t" label="Alignment tag"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
40 <param name="sec_key_select" type="select" label="Secondary sort key">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
41 <option value="">coordinate</option>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
42 <option value="-n">name (-n)</option>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
43 </param>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
44 </when>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
45 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
46 <!--<param name="compression" type="integer" argument="-l" optional="True" min="0" max="9" label="compression level" help="0 (uncompressed) to 9 (best)"/>-->
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
47 </inputs>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
48 <outputs>
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
49 <data name="output1" format="bam">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
50 <change_format>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
51 <when input="prim_key_cond.prim_key_select" value="" format="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
52 <when input="prim_key_cond.prim_key_select" value="-n" format="qname_sorted.bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
53 <when input="prim_key_cond.prim_key_select" value="-t" format="unsorted.bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
54 </change_format>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
55 </data>
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
56 </outputs>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
57 <tests>
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
58 <!-- tests from https://github.com/samtools/samtools/blob/9ce8c64493f7ea3fa69bc5c1ac980b1a8e3dcf1f/test/test.pl#L2464 -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
59 <!-- # Pos sort -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
60 <test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
61 <param name="input1" value="test_input_1_a.bam" ftype="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
62 <output name="output1" file="pos.sort.expected.bam" ftype="bam"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
63 </test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
64 <!-- test_cmd($opts, out=>"sort/pos.sort.expected.sam", cmd=>"$$opts{bin}/samtools sort${threads} $$opts{path}/dat/test_input_1_a.bam -O SAM -o -"); -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
65
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
66 <!-- # Name sort -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
67 <test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
68 <param name="input1" value="test_input_1_a.bam" ftype="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
69 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
70 <param name="prim_key_select" value="-n"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
71 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
72 <output name="output1" file="name.sort.expected.bam" ftype="qname_sorted.bam"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
73 </test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
74 <!-- test_cmd($opts, out=>"sort/name.sort.expected.sam", cmd=>"$$opts{bin}/samtools sort${threads} -n $$opts{path}/dat/test_input_1_a.bam -O SAM -o -");-->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
75
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
76 <!-- # Tag sort (RG) (considers output and name sorted) -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
77 <test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
78 <param name="input1" value="test_input_1_a.bam" ftype="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
79 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
80 <param name="prim_key_select" value="-t"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
81 <param name="tag" value="RG"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
82 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
83 <output name="output1" file="tag.rg.sort.expected.bam" ftype="unsorted.bam"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
84 </test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
85 <!--test_cmd($opts, out=>"sort/tag.rg.sort.expected.sam", cmd=>"$$opts{bin}/samtools sort${threads} -t RG $$opts{path}/dat/test_input_1_a.bam -O SAM -o -");-->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
86
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
87 <!-- # Tag sort (RG); secondary by name -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
88 <test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
89 <param name="input1" value="test_input_1_a.bam" ftype="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
90 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
91 <param name="prim_key_select" value="-t"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
92 <param name="tag" value="RG"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
93 <param name="sec_key_select" value="-n"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
94 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
95 <output name="output1" file="tag.rg.n.sort.expected.bam" ftype="unsorted.bam"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
96 </test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
97 <!--test_cmd($opts, out=>"sort/tag.rg.n.sort.expected.sam", cmd=>"$$opts{bin}/samtools sort${threads} -n -t RG $$opts{path}/dat/test_input_1_a.bam -O SAM -o -");-->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
98
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
99 <!-- # Tag sort (AS) -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
100 <test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
101 <param name="input1" value="test_input_1_a.bam" ftype="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
102 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
103 <param name="prim_key_select" value="-t"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
104 <param name="tag" value="AS"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
105 <param name="sec_key_select" value=""/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
106 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
107 <output name="output1" file="tag.as.sort.expected.bam" ftype="unsorted.bam"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
108 </test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
109 <!--test_cmd($opts, out=>"sort/tag.as.sort.expected.sam", cmd=>"$$opts{bin}/samtools sort${threads} -t AS $$opts{path}/dat/test_input_1_d.sam -O SAM -o -");-->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
110
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
111 <!-- # Tag sort (FI) -->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
112 <test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
113 <param name="input1" value="test_input_1_a.bam" ftype="bam" />
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
114 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
115 <param name="prim_key_select" value="-t"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
116 <param name="tag" value="FI"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
117 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
118 <output name="output1" file="tag.fi.sort.expected.bam" ftype="unsorted.bam"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
119 </test>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
120 <!--test_cmd($opts, out=>"sort/tag.fi.sort.expected.sam", cmd=>"$$opts{bin}/samtools sort${threads} -t FI $$opts{path}/dat/test_input_1_d.sam -O SAM -o -");-->
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
121
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
122 <!-- tests from old version -->
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
123 <test>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
124 <param name="input1" value="1.bam" ftype="bam" />
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
125 <output name="output1" file="1_sort.bam" ftype="bam" sort="True"/>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
126 </test>
6
191cec7b989b planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 5
diff changeset
127 <test>
191cec7b989b planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 5
diff changeset
128 <param name="input1" value="1.bam" ftype="bam" />
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
129 <conditional name="prim_key_cond">
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
130 <param name="prim_key_select" value="-n"/>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
131 </conditional>
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
132 <output name="output1" file="1_sort_read_names.bam" ftype="qname_sorted.bam"/>
6
191cec7b989b planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 5
diff changeset
133 </test>
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
134 </tests>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
135 <help>
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
136 **What it does**
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
137
9
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
138 Sort alignments by leftmost coordinates, or by read name when -n is used.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
139 An appropriate @HD-SO sort order header tag will be added or an existing
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
140 one updated if necessary.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
141
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
142 **Ordering Rules**
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
143
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
144 The following rules are used for ordering records.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
145
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
146 If option -t is in use, records are first sorted by the value of the given
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
147 alignment tag, and then by position or name (if using -n). For example, “-t RG”
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
148 will make read group the primary sort key. The rules for ordering by tag are:
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
149
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
150 - Records that do not have the tag are sorted before ones that do.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
151 - If the types of the tags are different, they will be sorted so that single
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
152 character tags (type A) come before array tags (type B), then string tags
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
153 (types H and Z), then numeric tags (types f and i).
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
154 - Numeric tags (types f and i) are compared by value. Note that comparisons of
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
155 floating-point values are subject to issues of rounding and precision.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
156 - String tags (types H and Z) are compared based on the binary contents of the
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
157 tag using the C strcmp(3) function.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
158 - Character tags (type A) are compared by binary character value.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
159 - No attempt is made to compare tags of other types — notably type B array values will not be compared.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
160
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
161 When the -n option is present, records are sorted by name. Names are compared so as to give a “natural” ordering — i.e. sections consisting of digits are compared numerically while all other sections are compared based on their binary representation. This means “a1” will come before “b1” and “a9” will come before “a10”. Records with the same name will be ordered according to the values of the READ1 and READ2 flags (see flags).
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
162
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
163 When the -n option is not present, reads are sorted by reference (according to the order of the @SQ header records), then by position in the reference, and then by the REVERSE flag.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
164
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
165 This has now been removed. The previous out.prefix argument (and -f option, if any) should be changed to an appropriate combination of -T PREFIX and -o FILE. The previous -o option should be removed, as output defaults to standard output.
17bed26ad17e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 9f6dd28ae31897068c9f8b5d842750d5d7cd600c
iuc
parents: 8
diff changeset
166
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
167 </help>
8
71d5c34fef4e planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/samtools/samtools_sort commit 411130b45dc30f7f24f41cdeec5e148c5d8faf40
iuc
parents: 6
diff changeset
168 <expand macro="citations"/>
3
5e12c7427fa3 new initial commit
martenson <cech.marten@gmail.com>
parents:
diff changeset
169 </tool>