annotate bandage_info.xml @ 0:067592b6b312 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16

<tool id="bandage_info" name="Bandage Info" version="@TOOL_VERSION@+galaxy0">
    <description>determine statistics of de novo assembly graphs</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <expand macro="version_command"/>
    <command detect_errors="exit_code">
    <![CDATA[
Bandage
    info
    '$input_file'
    $tsv
    > out.txt
    ]]></command>
    <inputs>
        <param name="input_file" type="data" format="tabular" label="Graphical Fragment Assembly" />
        <param argument="--tsv" type="boolean" checked="false" truevalue="--tsv" falsevalue="" label="Output the information in a single tab-delimited line starting with the graph file"/>
    </inputs>
    <outputs>
        <data name="outfile" format="txt" from_work_dir="out.txt" label="${tool.name} on ${on_string}: Assembly Graph Information"/>
    </outputs>
    <tests>
        <test>
            <param name="input_file" ftype="tabular" value="gfa.tabular"/>
            <param name="select_mode" value="info"/>
            <param name="tsv" value="True"/>
            <output name="outfile" ftype="txt" file="out.txt" compare="contains"/>
        </test>
        <test>
            <param name="input_file" ftype="tabular" value="gfa.tabular"/>
            <param name="select_mode" value="info"/>
            <output name="outfile" ftype="txt" file="out_standard.txt"/>
        </test>
    </tests>
    <help><![CDATA[

@BANDAGE_OVERVIEW@

**Command Documentation**

``Bandage info`` takes a graph file as input and outputs the following statistics about the graph:

- **Node count:** The number of nodes in the graph. Only positive nodes are counted (i.e. each complementary pair counts as one).
- **Edge count:** The number of edges in the graph. Only one edge in each complementary pair is counted.
- **Total length:** The total number of base pairs in the graph.
- **Dead ends:** The number of instances where an end of a node does not connect to any other nodes.
- **Percentage dead ends:** The proportion of possible dead ends. The maximum number of dead ends is twice the number of nodes (occurs when there are no edges), so this value is the number of dead ends divided by twice the node count.
- **Connected components:** The number of regions of the graph which are disconnected from each other.
- **Largest component:** The total number of base pairs in the largest connected component.
- **N50:** Nodes that are this length or greater will collectively add up to at least half of the total length.
- **Shortest node:** The length of the shortest node in the graph.
- **Lower quartile node:** The median node length for the shorter half of the nodes.
- **Median node:** The median node length for the graph.
- **Upper quartile node:** The median node length for the longer half of the nodes.
- **Longest node:** The length of the longest node in the graph.

Example output::

    Node count:               561
    Edge count:               734
    Total length (bp):        4878380
    Dead ends:                33
    Percentage dead ends:     2.94118%
    Connected components:     19
    Largest component (bp):   4821329
    N50 (bp):            90360
    Shortest node (bp):       1
    Lower quartile node (bp): 17
    Median node (bp):         87
    Upper quartile node (bp): 404
    Longest node (bp):        205425

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