annotate vsnp_sample_names.xml @ 4:67e3fa4bbc53 draft

"planemo upload for repository https://github.com/gregvonkuster/galaxy_tools/tree/master/tools/sequence_analysis/vsnp/vsnp_sample_names commit ff2ce94ece2147f04cf0f1964ed716012422d50f"

<tool id="vsnp_sample_names" name="vSNP: sample names" version="@WRAPPER_VERSION@.1" profile="@PROFILE@">
    <description></description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <command detect_errors="exit_code"><![CDATA[
#import os
#import re

#set sample_name_read2 = None

#if $input_type_cond.input_type in ['single', 'pair']:
    #set read1 = $input_type_cond.read1
    #set sample_name = re.sub('[^\s\w\-]', '_', str($read1.element_identifier))
#else:
    #set read1_filename = $input_type_cond.reads_collection['forward'].name
    #set sample_name = re.sub('[^\s\w\-]', '_', str($read1_filename))
#end if

#if $sample_name.find('_R1') >0:
    ## Something like CMC_20E1_R1.fastq.gz
    #set sample_name = $sample_name.split('_R1')[0]
#else if $sample_name.find(".") > 0:
    #if $read1.is_of_type('fastqsanger.gz'):
        ## Something like my_sample.fastq.gz
        #set sample_name = '.'.join($sample_name.split('.')[0:-2])
    #else:
        ## Something like my_sample.fastq
        #set sample_name = $os.path.splitext($sample_name)[0]
    #end if
#else if $sample_name.find("_") > 0:
    #if $read1.is_of_type('fastqsanger.gz'):
        ## Something like my_sample_fastq_gz
        #set sample_name = '_'.join($sample_name.split('_')[0:-2])
    #else:
        ## Something like my_sample_fastq
        #set sample_name = "_".join($sample_name.split("_")[0:-1])
    #end if
#end if
echo '$sample_name' > '$output'
]]></command>
    <inputs>
        <conditional name="input_type_cond">
            <param name="input_type" type="select" label="Choose the category of the files to be analyzed">
                <option value="single" selected="true">Single dataset</option>
                <option value="pair">Dataset pair</option>
                <option value="paired">List of dataset pairs</option>
            </param>
            <when value="single">
                <param name="read1" type="data" format="fastqsanger.gz,fastqsanger" label="Read1 fastq file"/>
            </when>
            <when value="paired">
                <param name="reads_collection" type="data_collection" format="fastqsanger,fastqsanger.gz" collection_type="paired" label="Collection of fastqsanger paired read files"/>
            </when>
            <when value="pair">
                <param name="read1" type="data" format="fastqsanger.gz,fastqsanger" label="Read1 fastq file"/>
                <param name="read2" type="data" format="fastqsanger.gz,fastqsanger" label="Read2 fastq file"/>
            </when>
        </conditional>
    </inputs>
    <outputs>
        <data name="output" format="txt"/>
    </outputs>
    <tests>
        <!-- Single files -->
        <test>
            <param name="input_type" value="single"/>
            <param name="read1" value="CMC_20E1_R1.fastq.gz" dbkey="89"/>
            <output name="output" file="sample_names.txt" ftype="txt"/>
        </test>
        <!-- Paired reads -->
        <test>
            <param name="input_type" value="paired"/>
            <param name="reads_collection">
                <collection type="paired">
                    <element name="forward" value="CMC_20E1_R1.fastq.gz"/>
                    <element name="reverse" value="CMC_20E1_R2.fastq.gz"/>
                </collection>
            </param>
            <output name="output" file="sample_names.txt" ftype="txt"/>
        </test>
        <!-- Paired reads in separate datasets -->
        <test>
            <param name="input_type" value="pair"/>
            <param name="read1" value="CMC_20E1_R1.fastq.gz" dbkey="89"/>
            <param name="read2" value="CMC_20E1_R2.fastq.gz" dbkey="89"/>
            <output name="output" file="sample_names.txt" ftype="txt"/>
        </test>
    </tests>
    <help>
**What it does**

Accepts fastqsanger sample files, extracts a unique portion of the file name as the sample name, and writes it to
the output.  The output text file can be consumed by the **Parse parameter value** expression tool to provide workflow
parameter values to the **Read group identifier (ID)** and the **Sample name identifier (SM)**  parameters in the
**Map with BWA-MEM** tool.
    </help>
    <expand macro="citations"/>
</tool>