annotate slopBed.xml @ 35:b28e0cfa7ba1 draft

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

<tool id="bedtools_slopbed" name="bedtools SlopBed" version="@TOOL_VERSION@">
    <description>adjust the size of intervals</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <expand macro="stdio" />
    <command><![CDATA[
bedtools slop
$pct
$strand
-g @GENOME_FILE@
-i '$inputA'
#if $addition.addition_select == 'b':
    -b $addition.b
#else:
    -l $addition.l
    -r $addition.r
#end if
$header
> '$output'
    ]]></command>
    <inputs>
        <param name="inputA" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file" />
        <expand macro="input_conditional_genome_file" />
        <param argument="-pct" type="boolean" truevalue="-pct" falsevalue="" checked="false"
            label="Define -l and -r as a fraction of the feature’s length"
            help="E.g. if used on a 1000bp feature, -l 0.50, will add 500 bp “upstream”" />
        <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false"
            label="Define -l and -r based on strand"
            help="If used, -l 500 for a negative-stranded feature, it will add 500 bp to the end coordinate" />
        <expand macro="addition" />
        <expand macro="print_header" />
    </inputs>
    <outputs>
        <data name="output" format="bed" />
    </outputs>
    <tests>
        <test>
            <param name="inputA" value="a.bed" ftype="bed" />
            <param name="genome_file_opts_selector" value="hist" />
            <param name="genome" value="mm9_chr1.len" ftype="bed" />
            <param name="addition_select" value="b" />
            <param name="b" value="5" />
            <output name="output" file="slopBed_result1.bed" ftype="bed" />
        </test>
        <test>
            <param name="inputA" value="a.bed" ftype="bed" />
            <param name="genome_file_opts_selector" value="hist" />
            <param name="genome" value="mm9_chr1.len" ftype="bed" />
            <param name="addition_select" value="lr" />
            <param name="l" value="2" />
            <param name="r" value="3" />
            <output name="output" file="slopBed_result2.bed" ftype="bed" />
        </test>
    </tests>
    <help><![CDATA[
**What it does**

bedtools slop will increase the size of each feature in a feature file by a user-defined number of bases. While something like this could be done with an awk '{OFS="\t" print $1,$2-&lt;slop>,$3+&lt;slop>}', bedtools slop will restrict the resizing to the size of the chromosome (i.e. no start &lt; 0 and no end > chromosome size).

.. image:: $PATH_TO_IMAGES/slop-glyph.png

.. class:: warningmark

In order to prevent the extension of intervals beyond chromosome boundaries, bedtools slop requires a genome file defining the length of each chromosome or contig.

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