view snpEff_download.xml @ 33:94653948fdb9 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/snpeff commit e4cbbb48006ac767c69efe53eab2a63306124bb5
author iuc
date Sat, 04 Oct 2025 17:00:46 +0000
parents ebe9fd7e5bd1
children
line wrap: on
line source

<tool id="snpEff_download" name="SnpEff download:" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="23.0">
    <description> download a pre-built database</description>
    <macros>
        <import>snpEff_macros.xml</import>
    </macros>
    <requirements>
        <expand macro="requirement" />
    </requirements>
    <expand macro="stdio" />
    <expand macro="version_command" />
    <command><![CDATA[
snpEff download -dataDir "\$PWD/temp" -v '$genome_version' &&
mkdir -p '$snpeff_db.files_path' &&
mv temp/'$genome_version' '$snpeff_db.files_path'
    ]]></command>
    <inputs>
        <param name="genome_version" type="text" value="" label="Select the annotation database you want to download (e.g. GRCh38.86, mm10 etc.)" help="The list of available databases can be obtained with 'SnpEff databases' tool">
            <validator type="empty_field" message="A genome version name is required" />
        </param>
    </inputs>
    <outputs>
        <data name="snpeff_db" format="snpeffdb" label="@SNPEFF_VERSION@ ${genome_version} database"/>
    </outputs>
    <tests>
        <test expect_failure="true">
            <!-- The only meaningful test for this tool currently often, but not always, fails
            when run from github because the download attempt from github gets blocked
            by the data provider.
            As a workaround we make the test fail consistently.
            Put the "e" back on "zair" for an actual download attempt. -->
            <param name="genome_version" value="ebola_zair"/>
            <!-- then also uncomment the ouput assertion
            <output name="snpeff_db">
                <assert_contents>
                    <has_text text="ebola_zaire" />
                </assert_contents>
            </output>
            -->
        </test>
    </tests>
    <help><![CDATA[
**What it does**

This tool downloads a specified database from a remote SnpEff repository. It deposits it into the history.

-------

.. class:: infomark

**The usage scenario**

Suppose you want to annoate a VCF file containing variants within mm10 version of the Mouse genome. To do this you can:

    #. Download mm10 snpEff database by typing *mm10* into **Select the annotation database...** text box.
    #. Use **SnpEff eff** by choosing the downloaded database from the history using *Downloaded snpEff database in your history* option of the **Genome source** parameter.

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