annotate data_manager/gtdbtk_database_installer.xml @ 7:3b1d503c6260 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/data_managers/data_manager_gtdbtk_database_installer commit 671e8c706fa211b6ec1c476d3d1a36d098822fe5

<tool id="gtdbtk_database_installer" name="GTDB-Tk Database Installer" tool_type="manage_data" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
    <description></description>
    <macros>
        <token name="@TOOL_VERSION@">202</token>
        <token name="@VERSION_SUFFIX@">3</token>
        <token name="@PROFILE@">20.09</token>
    </macros>
    <requirements>
        <requirement type="package" version="3.10.2">python</requirement>
    </requirements>
    <command>
    <![CDATA[
python '$__tool_directory__/gtdbtk_database_installer.py'
    --release '$release'
    --out_file '$out_file'
    $meta
    $test
    ]]>
    </command>
    <inputs>
	    <param name="meta" type="boolean" truevalue="--meta" falsevalue="" checked="false" label="Only store GTDBTK metadata in a dedicated data table. " />
        <param name="test" type="hidden" value="" checked="false" label="Run a dry test run!" />
        <param name="release" type="select" multiple="false" label="GTDB Release">
            <option value="202">202</option>
            <option value="207">207</option>
            <option value="214">214</option>
            <option value="220">220</option>
        </param>
    </inputs>
    <outputs>
        <data name="out_file" format="data_manager_json"/>
    </outputs>
    <tests>
        <test>
            <!-- Not actually installing a huge GTDB-Tk database -->
            <!-- but it will check if all urls exist -->
            <param name="release" value="202"/>
            <param name="test" value="--test"/>
            <output name="out_file">
                <assert_contents>
                    <has_text text="Full Database - release 202 "/>
                    <has_text text="full_database_release_202_downloaded"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <!-- Test meta data download with tsv.gz-->
            <param name="release" value="220"/>
            <param name="meta" value="true"/>
            <output name="out_file">
                <assert_contents>
                    <has_text text="Metadata Tables - release 220"/>
                    <has_text text="metadata_tables_release_220_downloaded_"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <!-- Test meta data download with tar.gz -->
            <param name="release" value="207"/>
            <param name="meta" value="true"/>
            <output name="out_file">
                <assert_contents>
                    <has_text text="Metadata Tables - release 207"/>
                    <has_text text="metadata_tables_release_207_downloaded_"/>
                </assert_contents>
            </output>
        </test>
    </tests>
    <help>
This data manager downloads the DB required for GTDB-Tk tools such as 
the `gtdbtk classify_wf`. The meta options allows downloading only the metadata for the 
corresponding DB, which is used by tools like `gtdb_to_taxdump`.
    </help>
    <citations>
        <citation type="doi">doi.org/10.1038/s41587-020-0501-8</citation>
        <citation type="doi">dx.doi.org/10.1038/nbt.4229</citation>
    </citations>
</tool>