view stacks_shortreads.xml @ 3:756e003f0eb1 draft

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

<!-- this is essentially a copy of stacks_procrad minus the unsupported options -->
<tool id="stacks2_shortreads" name="Stacks2: process shortreads" version="@STACKS_VERSION@+galaxy@WRAPPER_VERSION@">
<description>fast cleaning of randomly sheared genomic or transcriptomic data</description>
    <macros>
        <import>macros.xml</import>
        <import>macros_process.xml</import>
    </macros>
    <expand macro="requirements"/>
    <expand macro="stdio"/>
    <expand macro="version_cmd"/>
    <command><![CDATA[
@CLEAN_EXT@
mkdir stacks_inputs stacks_outputs &&
@FASTQ_INPUT_PREPROC@

process_shortreads

@PROCESS_IOOPTIONS@
@PROCESS_FILTER@
@COMMON_ADVANCED@
@RESCUE_BARCODE@
@PROCESS_ADAPTER@

## advanced options not shared between shortreads and radtags
$options_advanced.no_read_trimming
$options_advanced.mate_pair
$options_advanced.no_overhang

#if $output_log
    && mv stacks_outputs/process_shortreads.log $output_log
#end if
@PROCESS_FASTQ_POSTPROC@
    ]]></command>

    <inputs>
        <expand macro="process_inputs"/>
        <section name="options_advanced" title="advanced options" expanded="False">
	    <expand macro="common_advanced"/>
	    <param argument="--no_read_trimming" type="boolean" checked="false" truevalue="--no_read_trimming" falsevalue="" label="do not trim low quality reads, just discard them" />
	    <param argument="--mate-pair" name="mate_pair" type="boolean" checked="false" truevalue="--mate-pair" falsevalue="" label="raw reads are circularized mate-pair data, first read will be reverse complemented" />
	    <param argument="--no_overhang" type="boolean" checked="false" truevalue="--no_overhang" falsevalue="" label="data does not contain an overhang nucleotide between barcode and seqeunce" />
	    <expand macro="rescue_barcode"/>
	    <expand macro="process_adapter"/>
        </section>
	<expand macro="process_filter"/>
	<expand macro="process_output_types"/>
    </inputs>

    <outputs>
        <data format="txt" name="output_log" label="${tool.name} on ${on_string} log file" from_work_dir="stacks_outputs/process_shortreads.log" />
	<expand macro="process_outputs"/>
    </outputs>

    <tests>
	<!-- test single end, default options -->
        <test>
            <param name="input_type|options_type_selector" value="single"/>
            <param name="input_type|fqinputs" ftype="fastqsanger" value="procrad/R1.fq"/>
            <param name="input_type|barcode_encoding" value="--inline_null"/>
            <param name="barcode" value="procrad/barcodes"/>
            <param name="add_log" value="yes" />
            <output name="output_log" file="shortreads/process_shortreads.out" lines_diff="4"/>
            <output_collection name="demultiplexed" count="40">
                <element name="PopA_01" file="shortreads/PopA_01.fq" ftype="fastqsanger" />
            </output_collection>
        </test>
	<!-- test single end, default options -->
        <test>
            <param name="input_type|options_type_selector" value="paired"/>
            <param name="input_type|fqinputs">
                <collection type="list:paired">
                    <element name="reads">
                        <collection type="paired">
                            <element name="forward" value="procrad/R1.fq" ftype="fastqsanger" />
                            <element name="reverse" value="procrad/R2.fq" ftype="fastqsanger"/>
                        </collection>
                    </element>
                </collection>
            </param>
            <param name="input_type|barcode_encoding" value="--inline_null"/>
            <param name="barcode" value="procrad/barcodes"/>
            <param name="capture" value="true"/>
	    <param name="no_read_trimming" value="--no_read_trimming" />
	    <param name="mate_pair" value="--mate-pair" />
	    <param name="no_overhang" value="--no_overhang" />
	    <param name="outype" value="gzfastq"/>
            <param name="add_log" value="yes" />
            <assert_command>
                <has_text text="--no_read_trimming" />
                <has_text text="--mate-pair" />
                <has_text text="--no_overhang" />
            </assert_command>
            <output name="output_log" file="shortreads/process_shortreads.out" compare="sim_size"/>
            <output_collection name="demultiplexed_paired" type="list:paired" count="40">
                <element name="PopA_01">
                    <element name="forward" value="shortreads/PopA_01.forward.fq.gz" ftype="fastqsanger.gz" compare="sim_size"/>
                    <element name="reverse" value="shortreads/PopA_01.reverse.fq.gz" ftype="fastqsanger.gz" compare="sim_size"/>
                </element>
            </output_collection>
            <output_collection name="remaining" type="list:paired" count="40">
                <element name="PopA_01">
                    <element name="forward" file="shortreads/PopA_01.rem.forward.fq.gz" ftype="fastqsanger.gz"/>
                    <element name="reverse" file="shortreads/PopA_01.rem.reverse.fq.gz" ftype="fastqsanger.gz"/>
                </element>
            </output_collection>
            <output_collection name="discarded_paired" type="list:paired" count="1">
                <element name="reads">
                    <element name="forward" file="shortreads/reads.forward.fq" ftype="fastqsanger"/>
                    <element name="reverse" file="shortreads/reads.forward.fq" ftype="fastqsanger"/>
                </element>
            </output_collection>
        </test>
<!--        <test>-->
<!--            <param name="options_type_selector" value="single"/>-->
<!--            <param name="input_single" ftype="fastqsanger.gz" value="procrad/R1.fq.gzip"/>-->
<!--            <param name="barcode" value="procrad/barcodes"/>-->
<!--            <param name="discard" value="true"/>-->
<!--            <param name="capture" value="true"/>-->
<!--            <param name="outype" value="gzfastq"/>-->
<!--            <output name="output_log" file="shortreads/process_shortreads.out" lines_diff="6"/>-->
<!--            <output_collection name="demultiplexed">-->
<!--                <element name="PopA_01" ftype="fastqsanger.gz" md5="c7250f50138cbca747b85223aaae9565"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="discarded">-->
<!--                <element name="R1" ftype="fastqsanger" md5="786b30d864332a2d56d9179f0a53add4"/>-->
<!--            </output_collection>-->
<!--        </test>-->
<!--        <test>-->
<!--            <param name="options_type_selector" value="paired"/>-->
<!--            <param name="inputs_paired1" ftype="fastqsanger" value="procrad/R1.fq"/>-->
<!--            <param name="inputs_paired2" ftype="fastqsanger" value="procrad/R2.fq"/>-->
<!--            <param name="barcode" value="procrad/barcodes"/>-->
<!--            <param name="discard" value="true"/>-->
<!--            <param name="capture" value="true"/>-->
<!--            <output name="output_log" file="shortreads/process_shortreads_paired.out" lines_diff="4"/>-->
<!--            <output_collection name="demultiplexed">-->
<!--                <element name="PopA_01.1" file="demultiplexed/PopA_01.1.fq"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="remaining">-->
<!--                <element name="PopA_01.rem.2" file="demultiplexed/PopA_01.rem.2.fq"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="discarded">-->
<!--                <element name="R1" file="procrad/R1.fq.discards"/>-->
<!--            </output_collection>-->
<!--        </test>-->
<!--        <test>-->
<!--            <param name="options_type_selector" value="paired"/>-->
<!--            <param name="inputs_paired1" ftype="fastqsanger" value="procrad/R1.fq"/>-->
<!--            <param name="inputs_paired2" ftype="fastqsanger" value="procrad/R2.fq"/>-->
<!--            <param name="barcode" value="procrad/barcodes"/>-->
<!--            <param name="discard" value="true"/>-->
<!--            <param name="capture" value="true"/>-->
<!--            <param name="retain_header" value="true"/>-->
<!--            <output name="output_log" file="shortreads/process_shortreads_paired.out" lines_diff="4"/>-->
<!--            <output_collection name="demultiplexed">-->
<!--                <element name="PopA_01.1" file="demultiplexed/PopA_01.1.fq.header"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="remaining">-->
<!--                <element name="PopA_01.rem.2" file="demultiplexed/PopA_01.rem.2.fq.header"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="discarded">-->
<!--                <element name="R1" file="procrad/R1.fq.discards"/>-->
<!--            </output_collection>-->
<!--        </test>-->
<!--        <test>-->
<!--            <param name="options_type_selector" value="paired"/>-->
<!--            <param name="inputs_paired1" ftype="fastqsanger" value="procrad/R1.fq"/>-->
<!--            <param name="inputs_paired2" ftype="fastqsanger" value="procrad/R2.fq"/>-->
<!--            <param name="barcode" value="procrad/barcodes"/>-->
<!--            <param name="discard" value="true"/>-->
<!--            <param name="capture" value="true"/>-->
<!--            <param name="outype" value="fasta"/>-->
<!--            <output name="output_log" file="shortreads/process_shortreads_paired.out" lines_diff="4"/>-->
<!--            <output_collection name="demultiplexed">-->
<!--                <element name="PopA_01.1" file="demultiplexed/PopA_01.1.fa"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="remaining">-->
<!--                <element name="PopA_01.rem.2" file="demultiplexed/PopA_01.rem.2.fa"/>-->
<!--            </output_collection>-->
<!--            <output_collection name="discarded">-->
<!--                <element name="R1" file="procrad/R1.fa.discards"/>-->
<!--            </output_collection>-->
<!--        </test>-->
    </tests>



    <help>
<![CDATA[
.. class:: infomark

**What it does**

erforms the same task as process_radtags for fast cleaning of randomly sheared genomic or transcriptomic data, not for RAD data.

**Help**

Input files:

- FASTQ

- Barcode File Format

The barcode file is a very simple format:

======= ===========
Barcode Sample name
======= ===========
ATGGGG  PopA_01
GGGTAA  PopA_02
AGGAAA  PopA_03
TTTAAG  PopA_04
GGTGTG  PopA_05
TGATGT  PopA_06
======= ===========

Combinatorial barcodes are specified, one per column, separated by a tab:

======== ======== ===========
Barcode1 Barcode2 Sample name
======== ======== ===========
CGATA    ACGTA    PopA_01
CGGCG    CGTA     PopA_02
GAAGC    CGTA     PopA_03
GAGAT    CGTA     PopA_04
CGATA    AGCA     PopA_05
CGGCG    AGCA     PopA_06
======== ======== ===========

@STACKS_INFOS@
]]>
    </help>
    <expand macro="citation" />
</tool>