annotate convert.xml @ 0:e2b5f503e7b8 draft

Imported from capsule None

1 <tool id="convert" name="Convert">
2   <description>between different sequence data formats</description>
3   <requirements>
4     <requirement type="package" version="0.1.5">mimodd</requirement>
5   </requirements>
6   <version_command>mimodd version -q</version_command>
7   <command>
8 	mimodd convert 
9  
10   	#for $i in $mode.input_list
11 	    ${i.file1}
12 	    #if $str($mode.iformat) in ("fastq_pe", "gz_pe"):
13 		${i.file2}
14 	    #end if
15 	#end for
16 	#if $str($mode.header) != "None":  	
17 		--header $(mode.header)
18 	#end if
19 	--ofile $outputname
20 	--iformat $(mode.iformat)
21 	--oformat $(mode.oformat)
22   </command>
23   
24   <inputs>
25     <conditional name="mode">
26 	<param name="iformat" type="select" label="input file format" help="Your choice will update the interface to display further choices appropriate for your type of input data.">
27 	    <option value="fastq">fastq: single-end (one file)</option>
28 	    <option value="fastq_pe">fastq: paired-end (two files)</option>
29 	    <option value="gz">gzip compressed fastq: single-end (one file)</option>
30 	    <option value="gz_pe">gzip compressed fastq: paired-end (two files)</option>
31 	    <option value="sam">sam</option>
32 	    <option value="bam">bam</option>
33         </param>	
34             <when value="fastq">
35 	      <param name="oformat" type="select" label="output file format">
36 	        <option value="sam">sam</option>
37 	        <option value="bam">bam</option>
38 	      </param>
39 	    <repeat name="input_list" title="fastq input dataset" default="1" min="1">
40 		<param name="file1" format="fastq" type="data" label="inputfile"/>
41 	    </repeat>
42         <param name="header" type="data" format="sam" label="Use Header File" help="A SAM file with header information, as generated, for example, by the NGS Run Annotation Tool, that will be used to attach metainformation to the results file."/>	    
43 	    </when>
44 	    <when value="fastq_pe">
45 	      <param name="oformat" type="select" label="output file format">
46 	        <option value="sam">sam</option>
47 	        <option value="bam">bam</option>
48 	      </param>
49 	      <repeat name="input_list" title="fastq input datasets" default="1" min="1">
50 		  <param format="fastq" name="file1" type="data" label="inputfile with the first set of reads of paired-end data"/>		
51 		  <param format="fastq" name="file2" type="data" label="inputfile with the second set of reads of paired-end data"/>
52 	      </repeat>
53           <param name="header" type="data" format="sam" label="Use Header File" help="A SAM file with header information, as generated, for example, by the NGS Run Annotation Tool, that will be used to attach metainformation to the results file."/>
54 	    </when>
55         <when value="gz">
56 	      <param name="oformat" type="select" label="output file format">
57 	        <option value="sam">sam</option>
58 	        <option value="bam">bam</option>
59 	      </param>
60 	    <repeat name="input_list" title="fastq.gz input dataset" default="1" min="1">
61 		<param name="file1" format="data" type="data" label="inputfile"/>
62 	    </repeat>
63         <param name="header" type="data" format="sam" label="Use Header File" help="A SAM file with header information, as generated, for example, by the NGS Run Annotation Tool, that will be used to attach metainformation to the results file."/>
64 	    </when>
65 	    <when value="gz_pe">
66 	      <param name="oformat" type="select" label="output file format">
67 	        <option value="sam">sam</option>
68 	        <option value="bam">bam</option>
69 	      </param>
70 	      <repeat name="input_list" title="fastq.gz input datasets" default="1" min="1">
71 		<param format="data" name="file1" type="data" label="inputfile with the first set of reads of paired-end data"/>		
72 		<param format="data" name="file2" type="data" label="inputfile with the second set of reads of paired-end data"/>
73 	    </repeat>
74         <param name="header" type="data" format="sam" label="Use Header File" help="A SAM file with header information, as generated, for example, by the NGS Run Annotation Tool, that will be used to attach metainformation to the results file."/>
75 	    </when>
76 	    <when value="sam">
77 	      <param name="oformat" type="select" label="output file format">
78 	        <option value="bam">bam</option>
79 	      </param>
80 	      <repeat name="input_list" title="sam input dataset" default="1" min="1" max="1">
81 		<param name="file1" format="sam" type="data" label="inputfile"/>
82 	    </repeat>
83 	    <param name="header" type="hidden" value="None"/>
84 	    </when>
85 	    <when value="bam">
86 	      <param name="oformat" type="select" label="output file format">
87 	        <option value="sam">sam</option>
88 	      </param>
89 	      <repeat name="input_list" title="bam input dataset" default="1" min="1" max="1">
90 		<param name="file1" format="bam" type="data" label="inputfile"/>
91 	    </repeat>
92 	    <param name="header" type="hidden" value="None"/>
93 	    </when>
94     </conditional>
95   </inputs>
96   
97   <outputs>
98     <data name="outputname" format="bam" label="Converted reads from MiModd ${tool.name} on ${on_string}">
99 	<change_format>
00 	    <when input="mode.oformat" value="sam" format="sam" />
01 	</change_format>
02     </data>
03   </outputs>
04 
05 <help>
06 .. class:: infomark
07 
08    **What it does**
09 
10 The tool converts between different file formats used for storing next-generation sequencing data.
11 
12 As input file types it can handle uncompressed or gzipped fastq, SAM or BAM format, which it can convert to SAM or BAM format.
13 
14 **Notes:**
15 
16 1) In its standard configuration Galaxy will decompress any .gz files during their upload, so the option to align gzipped fastq input is useful only with customized Galaxy instances or by using linked files as explained in our `recipe for using gzipped fastq files in Galaxy`_ from the `MiModD user guide`_.
17 
18 2) The tool can convert fastq files representing data from paired-end sequencing runs to appropriate SAM/BAM format provided that the mate information is split over two fastq files in corresponding order.
19 
20    **TIP:** If your paired-end data is arranged differently, you may look into the *fastq splitter* and *fastq de-interlacer* tools for Galaxy from the `Fastq Manipulation category`_ of the Galaxy Tool Shed to see if they can convert your files to the expected format.
21    
22 3) Merging partial fastq (or gzipped fastq) files into a single SAM/BAM file is supported both for single-end and paired-end data. Simply add additional input datasets and select the appropriate files (pairs of files in case of paired-end data).
23 
24    Concatenation of SAM/BAM file during conversion is currently not supported.
25 
26 4) For input in fastq format a SAM header file providing run metadata **has to be specified**. The information in this file will be used as the header data of the new SAM/BAM file. You can use the *NGS Run Annotation* tool to generate a new header file for your data.
27 
28    For input in SAM/BAM format the tool will simply copy the existing header data to the new file. To modify the header of an existing SAM/BAM file, use the *Reheader BAM file* tool instead.
29 
30 .. _Fastq Manipulation category: https://toolshed.g2.bx.psu.edu/repository/browse_repositories_in_category?id=310ff67d4caf6531
31 .. _recipe for using gzipped fastq files in Galaxy: http://mimodd.readthedocs.org/en/latest/recipes.html#use-gzipped-fastq-files-in-galaxy
32 .. _MiModD user guide: http://mimodd.readthedocs.org/en/latest
33 
34 </help>
35 </tool>
36