annotate syncpairs.xml @ 2:b4e854fde491 draft default tip

Uploaded

<tool id="syncpairs" name="Sync Fastq Pairs" version="0.0.1">
    <description>Runes sncy pairs on two fastq files.</description>
    <requirements>
        <requirement type="package" version="1.66">biopython</requirement>
    </requirements>
    <stdio>
        <!-- Anything other than zero is an error -->
        <exit_code range="1:" />
        <exit_code range=":-1" />
    </stdio>
    <command interpreter="python">
        syncpairs.py $reads1 $reads2 $reads1_output $reads2_output
    </command>
    <inputs>
        <param name="reads1" type="data" format="fastq,fastqsanger" label="Read1 Fastq File" />
        <param name="reads2" type="data" format="fastq,fastqsanger" label="Read2 Fastq File" />
    </inputs>
    <outputs>
        <data name="reads1_output" format_source="reads1" label="Synced Read 1 from ${on_string}"/>
        <data name="reads2_output" format_source="reads2" label="Synced Read 2 from ${on_string}"/>
     </outputs>
    <tests>
        <!-- Large dataset in github but not toolshed -->
        <!--test>
            <param name="reads1" value="C75_S29_R1_001.fq" ftype="fastq" /> 
            <param name="reads2" value="C75_S29_R2_001.fastq" ftype="fastq" /> 
            <output name="reads1_output" file="C75_S29_R1_001_extracted.fastq" ftype="fastq" />
            <output name="reads2_output" file="C75_S29_R2_001_extracted.fastq" ftype="fastq" />
        </test-->
        <test>
            <param name="reads1" value="read1.fq" ftype="fastqsanger" /> 
            <param name="reads2" value="read2.fastq" ftype="fastqsanger" /> 
            <output name="reads1_output" file="read1_extracted.fastq" ftype="fastqsanger" />
            <output name="reads2_output" file="read2_extracted.fastq" ftype="fastqsanger" />
        </test>
    </tests>
    <help>
<![CDATA[
Description taken from source: https://github.com/mmendez12/sync_paired_end_reads

sync_paired_end_reads

sync_paired_end_reads is a python tool to synchronise paired-end reads when reads1 or reads2 were modified.

When working with paired-end sequencing data, it is common to filter out reads that do not pass basic quality controls. This leads to pairs that are not synced anymore. This tool streams reads1 and search for the associated read2 in reads2. Additionally it synchronises the sequence identifiers of the reads so if a software modified the sequence identifier of the reads1 then same identifiers will be used for reads2. Finally it replaces all space characters by an arbitrary '___' pattern.

This tool was mainly developed to process the output of tagdust2 when ran in single-end mode which appends the UMIs found in the raw sequences to the sequence identifier.
Install

]]>
    </help>
    <citations>
        <citation type="bibtex">
            @misc{
                sync_paired_end_reads,
                author = {Mickaël Mendez},
                title = {sync_paired_end_reads on Github},
                publisher = {GitHub},
                journal = {GitHub repository},
                url = {https://github.com/mmendez12/sync_paired_end_reads},
                commit = {afd9bf092ed55a65f90f28f40d6230c5fe849223}
            }
        </citation>
    </citations>
</tool>