view samtools_sort.xml @ 5:346239545aa0 draft

Uploaded tool xml with improved command line.
author devteam
date Thu, 16 Oct 2014 12:42:20 -0400
parents 1d317aeacef4
children 191cec7b989b
line wrap: on
line source

<tool id="samtools_sort" name="sort" version="1.0.3">
    <requirements>
        <requirement type="package" version="1.1">samtools</requirement>
    </requirements>
    <description>a BAM file</description>
    <version_command>samtools --version | head -n 1 | awk '{ print $2 }'</version_command>
    <command>samtools sort $sort_mode "${input1}" -o "${output1}" -O bam -T dataset</command>
    <stdio>
        <exit_code range="1:" level="fatal" description="Error" />
    </stdio>
    <inputs>
        <param name="input1" type="data" format="bam" label="BAM File" />
        <param name="sort_mode" type="select" label="Sort by ">
            <option value="" selected="True">Chromosomal coordinates</option>
            <option value="-n">Read names</option>
        </param>
    </inputs>
    <outputs>
        <data name="output1" format="bam" />
    </outputs>
    <tests>
        <test>
            <param name="input1" value="1.bam" ftype="bam" />
            <output name="output1" file="1_sort.bam" ftype="bam" sort="True"/>
        </test>
    </tests>
    <help>

**What it does**

This tool uses the SAMTools_ toolkit to sort alignments by leftmost coordinates or read names.

.. _SAMTools: http://samtools.sourceforge.net/samtools.shtml

------

**Citation**

For the underlying tool, please cite `Li H, Handsaker B, Wysoker A, Fennell T, Ruan J, Homer N, Marth G, Abecasis G, Durbin R; 1000 Genome Project Data Processing Subgroup. The Sequence Alignment/Map format and SAMtools. Bioinformatics. 2009 Aug 15;25(16):2078-9. &lt;http://www.ncbi.nlm.nih.gov/pubmed/19505943&gt;`_

If you use this tool in Galaxy, please cite Blankenberg D, et al. *In preparation.*

    </help>
</tool>