annotate sortBed.xml @ 41:7ab85ac5f64b draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"

<tool id="bedtools_sortbed" name="bedtools SortBED" version="@TOOL_VERSION@" profile="@PROFILE@">
    <description>order the intervals</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="bio_tools" />
    <expand macro="requirements" />
    <expand macro="stdio" />
    <command><![CDATA[
sortBed
-i '$input'
$option
@GENOME_FILE_MAPBED@
> '$output'
    ]]></command>
    <inputs>
        <param name="input" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="Sort the following @STD_BEDTOOLS_INPUT_LABEL@ file" />
        <param name="option" type="select" label="Sort by">
            <!-- sort -k 1,1 -k2,2 -n a.bed -->
            <option value="">chromosome, then by start position (asc)</option>
            <option value="-sizeA">feature size in ascending order.</option>
            <option value="-sizeD">feature size in descending order.</option>
            <option value="-chrThenSizeA">chromosome, then by feature size (asc).</option>
            <option value="-chrThenSizeD">chromosome, then by feature size (desc).</option>
            <option value="-chrThenScoreA">chromosome, then by score (asc).</option>
            <option value="-chrThenScoreD">chromosome, then by score (desc).</option>
        </param>
        <expand macro="input_optional_genome_file" />
    </inputs>
    <outputs>
        <data name="output" format_source="input" metadata_source="input" label="SortBed on ${input.name}"/>
    </outputs>
    <tests>
        <test>
            <param name="input" value="sortBed1.bed" ftype="bed" />
            <param name="option" value="" />
            <output name="output" file="sortBed_result1.bed" ftype="bed" />
        </test>
        <test>
            <param name="input" value="sortBed2.bed" ftype="bed" />
            <param name="option" value="" />
            <output name="output" file="sortBed_result2.bed" ftype="bed" />
        </test>
        <test>
            <param name="input" value="sortBed2.bed" ftype="bed" />
            <param name="option" value="" />
            <param name="genome_choose" value="-g" />
            <param name="genome_file_opts_selector" value="hist" />
            <param name="genome" value="mm9.len" ftype="bed" />
            <output name="output" file="sortBed_result3.bed" ftype="bed" />
        </test>
    </tests>
    <help><![CDATA[
**What it does**

Sorts a feature file by chromosome and other criteria.


.. class:: warningmark

It should be noted that sortBed is merely a convenience utility, as the UNIX sort utility
will sort BED files more quickly while using less memory. For example, UNIX sort will sort a BED file
by chromosome then by start position in the following manner: sort -k 1,1 -k2,2 -n a.bed

@REFERENCES@
    ]]></help>
    <expand macro="citations" />
</tool>