annotate tools/ncbi_blast_plus/ncbi_blastdbcmd_info.xml @ 16:b5f1f599d1fb draft

Uploaded v0.1.04, fix regression with BLAST database from history

<tool id="ncbi_blastdbcmd_info" name="NCBI BLAST+ database info" version="0.1.04">
    <description>Show BLAST database information from blastdbcmd</description>
    <macros>
        <token name="@BINARY@">blastdbcmd</token>
        <import>ncbi_macros.xml</import>
    </macros>
    <expand macro="preamble" />
    <command>
blastdbcmd -dbtype $db_opts.db_type -db "${db_opts.database.fields.path}" -info -out "$info"
    </command>
    <inputs>
        <expand macro="input_conditional_choose_db_type" />
    </inputs>
    <outputs>
        <data name="info" format="txt" label="${db_opts.database.fields.name} info" />
    </outputs>
    <tests>
        <!-- Disable for ToolShed where *.loc tests not yet supported
             See https://github.com/peterjc/galaxy_blast/issues/53
        <test>
            <param name="db_opts|db_type" value="prot" />
            <param name="db_opts|database" value="four_human_proteins" />
            <output name="info" file="four_human_proteins.dbinfo.txt" ftype="txt" lines_diff="4" />
        </test>
        <test>
            <param name="db_opts|db_type" value="nucl" />
            <param name="db_opts|database" value="three_human_mRNA" />
            <output name="info" file="three_human_mRNA.dbinfo.txt" ftype="txt" lines_diff="4" />
        </test>
        -->
    </tests>
    <help>
    
**What it does**

Calls the NCBI BLAST+ blastdbcmd command line tool with the -info
switch to give summary information about a BLAST database, such as
the size (number of sequences and total length) and date.

-------

**References**

If you use this Galaxy tool in work leading to a scientific publication please
cite the following papers:

@REFERENCES@
    </help>
    <expand macro="blast_citations" />
</tool>