annotate fastq_paired_end_splitter.xml @ 5:e39cc71d3ed6 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/galaxy_sequence_utils/fastq_paired_end_splitter commit a1525904286610e94e833a648d9b20aebb0967e7"

<tool id="fastq_paired_end_splitter" name="FASTQ splitter" version="@TOOL_VERSION@+galaxy1">
    <description>on joined paired end reads</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <edam_topics>
        <edam_topic>topic_0622</edam_topic>
    </edam_topics>
    <edam_operations>
        <edam_operation>operation_3359</edam_operation>
    </edam_operations>
    <command><![CDATA[
gx-fastq-paired-end-splitter '$input1_file' '${input1_file.extension[len('fastq'):]}' '$output1_file' '$output2_file'
    ]]></command>
    <inputs>
        <param name="input1_file" type="data" format="fastqsanger,fastqcssanger,fastqsanger.gz,fastqcssanger.gz,fastqsanger.bz2,fastqcssanger.bz2" label="FASTQ reads" />
    </inputs>
    <outputs>
        <data name="output1_file" format_source="input1_file" label="${tool.name} on ${on_string}: Forward"/>
        <data name="output2_file" format_source="input1_file" label="${tool.name} on ${on_string}: Reverse"/>
    </outputs>
    <tests>
        <test>
            <param name="input1_file" value="3.fastqsanger" ftype="fastqsanger" />
            <output name="output1_file" file="split_pair_reads_1.fastqsanger" ftype="fastqsanger" />
            <output name="output2_file" file="split_pair_reads_2.fastqsanger" ftype="fastqsanger" />
        </test>
    </tests>
    <help><![CDATA[
**What it does**

Splits a single fastq dataset representing paired-end run into two datasets (one for each end). This tool works only for datasets where both ends have **the same** length.

Sequence identifiers will have /1 or /2 appended for the split forward and reverse reads, respectively.

-----

**Input format**

A multiple-fastq file, for example::

    @HWI-EAS91_1_30788AAXX:7:21:1542:1758
    GTCAATTGTACTGGTCAATACTAAAAGAATAGGATCGCTCCTAGCATCTGGAGTCTCTATCACCTGAGCCCA
    +HWI-EAS91_1_30788AAXX:7:21:1542:1758
    hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh`hfhhVZSWehR

-----

**Outputs**

Forward Read::

    @HWI-EAS91_1_30788AAXX:7:21:1542:1758/1
    GTCAATTGTACTGGTCAATACTAAAAGAATAGGATC
    +HWI-EAS91_1_30788AAXX:7:21:1542:1758/1
    hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh

Reverse Read::

    @HWI-EAS91_1_30788AAXX:7:21:1542:1758/2
    GCTCCTAGCATCTGGAGTCTCTATCACCTGAGCCCA
    +HWI-EAS91_1_30788AAXX:7:21:1542:1758/2
    hhhhhhhhhhhhhhhhhhhhhhhh`hfhhVZSWehR
    ]]></help>
    <citations>
        <citation type="doi">10.1093/bioinformatics/btq281</citation>
    </citations>
</tool>