annotate maskFastaBed.xml @ 35:b28e0cfa7ba1 draft

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

<tool id="bedtools_maskfastabed" name="bedtools MaskFastaBed" version="@TOOL_VERSION@">
    <description>use intervals to mask sequences from a FASTA file</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <expand macro="stdio" />
    <command><![CDATA[
bedtools maskfasta
$soft
-mc '${mc}'
-fi '${fasta}'
-bed '${input}'
-fo '${output}'
$fullheader
    ]]></command>
    <inputs>
        <param name="input" argument="-bed" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
        <param name="fasta" argument="-fi" type="data" format="fasta" label="FASTA file"/>
        <param argument="-soft" type="boolean" truevalue="-soft" falsevalue="" checked="false"
            label="Soft-mask (that is, convert to lower-case bases) the FASTA sequence"
            help="By default, hard-masking (that is, conversion to Ns) is performed" />
        <param argument="-mc" type="text"  value="N"
            label="Replace masking character"
            help="That is, instead of masking with Ns, use another character" />
        <param argument="-fullHeader" name="fullheader" type="boolean" truevalue="-fullHeader" falsevalue=""
            label="Use full fasta header."
            help="By default, only the word before the first space or tab is used"/>
    </inputs>
    <outputs>
        <data name="output" format="fasta" />
    </outputs>
    <tests>
        <test>
            <param name="input" value="nucBed1.bed" ftype="bed" />
            <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
            <param name="soft" value="False" />
            <output name="output" file="maskFastaBed_result1.fasta" ftype="fasta" />
        </test>
        <test>
            <param name="input" value="nucBed1.bed" ftype="bed" />
            <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
            <param name="soft" value="True" />
            <output name="output" file="maskFastaBed_result2.fasta" ftype="fasta" />
        </test>
        <test>
            <param name="input" value="nucBed1.bed" ftype="bed" />
            <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
            <param name="soft" value="True" />
            <param name="fullheader" value="True" />
            <output name="output" file="maskFastaBed_result3.fasta" ftype="fasta" />
        </test>
    </tests>
    <help><![CDATA[
**What it does**

bedtools maskfasta masks sequences in a FASTA file based on intervals defined in a feature file. The headers in the input FASTA file must exactly match the chromosome column in the feature file. This may be useful fro creating your own masked genome file based on custom annotations or for masking all but your target regions when aligning sequence data from a targeted capture experiment.

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

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