annotate fgbio_sort_bam.xml @ 0:286e35cf3f1c draft

"planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
author jjohnson
date Sun, 21 Feb 2021 23:41:16 +0000
parents
children cb58d1961fd3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
1 <tool id="fgbio_sort_bam" name="fgbio SortBam" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" python_template_version="3.5">
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
2 <description>Sorts a SAM or BAM file</description>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
3 <macros>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
4 <import>macros.xml</import>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
5 </macros>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
6 <expand macro="requirements" />
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
7 <version_command>fgbio --version</version_command>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
9 fgbio SortBam"
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
10 --input '$input'
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
11 --sort-order=$sort_order
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
12 --output '$output'
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
13 ]]></command>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
14 <inputs>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
15 <param name="input" type="data" format="bam,sam" label="SAM/BAM to sort"/>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
16 <expand macro="sam_sort_order" />
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
17 </inputs>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
18 <outputs>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
19 <data name="output" format="unsorted.bam" />
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
20 </outputs>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
21 <help><![CDATA[
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
22 **fgbio SortBam**
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
23
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
24 Sorts a SAM or BAM file. Several sort orders are available:
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
25
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
26 - Coordinate: sorts reads by their reference sequence and left-most aligned coordinate
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
27 - Queryname: sort the reads by their query (i.e. read) name
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
28 - Random: sorts the reads into a random order. The output is deterministic for any given input. and several
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
29 - RandomQuery: sorts the reads into a random order but keeps reads with the same queryname together. The ordering is deterministic for any given input.
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
30
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
31 http://fulcrumgenomics.github.io/fgbio/tools/latest/SortBam.html
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
32 ]]></help>
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
33 <expand macro="citations" />
286e35cf3f1c "planemo upload commit 61f6c8e7f32f170ad7e66e46dd74e8c5d361a722"
jjohnson
parents:
diff changeset
34 </tool>