view kraken.xml @ 1:656215d2a793 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/blob/master/tool_collections/kraken/kraken/ commit cb1743eafd4ca98be0148d557770ef8635cc8d4c-dirty

<?xml version="1.0"?>
<tool id="kraken" name="Kraken" version="1.0.0">
    <description>
        assign taxonomic labels to short DNA reads
    </description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <command>
        <![CDATA[
        @SET_DATABASE_PATH@ &&
        kraken --threads \${GALAXY_SLOTS:-1} @INPUT_DATABASE@ 
        "$input_sequences"
        #if $split_reads:
            --classified-out "${classified_out}" --unclassified-out "${unclassified_out}"
        #end if
        --output "${output}" &&
        kraken-translate --db ${kraken_database.fields.name} "${output}" > "${translated}"
        ]]>
    </command>
    <inputs>
        <param format="fasta,fastq,fastqsanger" label="Input sequences" name="input_sequences" type="data" />
        <param label="Output classified and unclassified reads" name="split_reads" type="boolean" />
        <expand macro="input_database" />
    </inputs>
    <outputs>
        <data format="tabular" label="${tool.name} on ${on_string}: Classified reads" name="classified_out">
            <filter>(split_reads)</filter>
        </data>
        <data format="tabular" label="${tool.name} on ${on_string}: Unclassified reads" name="unclassified_out">
            <filter>(split_reads)</filter>
        </data>
        <data format="tabular" label="${tool.name} on ${on_string}: Histogram" name="histogram">
            <filter>(draw_histogram)</filter>
        </data>
        <data format="tabular" label="${tool.name} on ${on_string}: Classification" name="output" />
        <data format="tabular" label="${tool.name} on ${on_string}: Translated classification" name="translated" />
    </outputs>
    <help>
        <![CDATA[
        **What it does**

        Kraken is a taxonomic sequence classifier that assigns taxonomic labels to short DNA reads. It does this by examining the k-mers within a read and querying a database with those k-mers. This database contains a mapping of every k-mer in Kraken's genomic library to the lowest common ancestor (LCA) in a taxonomic tree of all genomes that contain that k-mer. The set of LCA taxa that correspond to the k-mers in a read are then analyzed to create a single taxonomic label for the read; this label can be any of the nodes in the taxonomic tree. Kraken is designed to be rapid, sensitive, and highly precise. Our tests on various real and simulated data have shown Kraken to have sensitivity slightly lower than Megablast with precision being slightly higher. On a set of simulated 100 bp reads, Kraken processed over 1.3 million reads per minute on a single core in normal operation, and over 4.1 million reads per minute in quick operation.

        **Usage**

        Kraken classifies a set of sequences (reads) with the commands below:

        kraken --db $DBNAME sequences.fa > sequences.kraken

        or

        kraken --db $DBNAME sequences.fq > sequences.kraken


        -DBNAME is the name of the Kraken Database to be used.

        -sequences.fa or sequences.fq is the FASTA or FASTQ input file containing the desired sequences for classification.

        -sequences.kraken is the generated output.



        **Options**

        The kraken program allows several different sequencing modifiers (parameters):

        **Multithreading:** Use the --threads NUM switch to use multiple threads.

        **Sequence filtering:** Classified or unclassified sequences can be sent to a file for later processing, using the --classified-out and --unclassified-out switches, respectively.



        **Output Format**

        Each sequence classified by Kraken results in a single line of output. Output lines contain five tab-delimited fields; from left to right, they are:

        1. "C"/"U": one letter code indicating that the sequence was either classified or unclassified.
        2. The sequence ID, obtained from the FASTA/FASTQ header.
        3. The taxonomy ID Kraken used to label the sequence; this is 0 if the sequence is unclassified.
        4. The length of the sequence in bp.

        5. A space-delimited list indicating the LCA mapping of each k-mer in the sequence. For example, "562:13 561:4 A:31 0:1 562:3" would indicate that:
            a) the first 13 k-mers mapped to taxonomy ID #562
            b) the next 4 k-mers mapped to taxonomy ID #561
            c) the next 31 k-mers contained an ambiguous nucleotide
            d) the next k-mer was not in the database
            e) the last 3 k-mers mapped to taxonomy ID #562
        ]]>
    </help>
    <expand macro="requirements" />
    <expand macro="stdio" />
    <expand macro="version_command" />
    <expand macro="citations" />
</tool>