annotate convert.xml @ 0:7da2c9654a83 draft default tip

Uploaded
author wolma
date Tue, 12 Aug 2014 11:26:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
1 <tool id="convert" name="Convert">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
2 <description>between different sequence data formats</description>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
3 <requirements>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
4 <requirement type="package" version="3.4.1">python3</requirement>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
5 <requirement type="package" version="0.1.3_9af04e0e9125">MiModD</requirement>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
6 </requirements>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
7 <command>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
8 mimodd convert
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
9
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
10 #for $i in $mode.input_list
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
11 ${i.file1}
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
12 #if $str($mode.iformat) in ("fastq_pe", "gz_pe"):
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
13 ${i.file2}
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
14 #end if
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
15 #end for
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
16 #if $str($header) != "None":
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
17 --header $header
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
18 #end if
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
19 --output $outputname
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
20 --iformat $(mode.iformat)
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
21 --oformat $(mode.oformat)
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
22 </command>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
23
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
24 <inputs>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
25 <conditional name="mode">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
26 <param name="iformat" type="select" label="choose the input file format" help="Your data will have to be in a single file if it comes from single-end sequencing, but will have to be arranged in two files if it comes from paired-end sequencing.">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
27 <option value="fastq">fastq: single-end (one file)</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
28 <option value="fastq_pe">fastq: paired-end (two files)</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
29 <option value="gz">gzip compressed fastq: single-end (one file)</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
30 <option value="gz_pe">gzip compressed fastq: paired-end (two files)</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
31 <option value="sam">sam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
32 <option value="bam">bam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
33 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
34 <when value="fastq">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
35 <param name="oformat" type="select" label="choose the output file format">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
36 <option value="sam">sam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
37 <option value="bam">bam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
38 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
39 <repeat name="input_list" title="fastq input dataset" default="1" min="1">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
40 <param name="file1" format="fastq" type="data" label="inputfile"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
41 </repeat>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
42 </when>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
43 <when value="fastq_pe">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
44 <param name="oformat" type="select" label="choose the output file format">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
45 <option value="sam">sam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
46 <option value="bam">bam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
47 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
48 <repeat name="input_list" title="fastq input datasets" default="1" min="1">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
49 <param format="fastq" name="file1" type="data" label="inputfile 1"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
50 <param format="fastq" name="file2" type="data" label="inputfile 2"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
51 </repeat>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
52 </when>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
53 <when value="gz">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
54 <param name="oformat" type="select" label="choose the output file format">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
55 <option value="sam">sam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
56 <option value="bam">bam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
57 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
58 <repeat name="input_list" title="fastq.gz input dataset" default="1" min="1">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
59 <param name="file1" format="data" type="data" label="inputfile"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
60 </repeat>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
61 </when>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
62 <when value="gz_pe">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
63 <param name="oformat" type="select" label="choose the output file format">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
64 <option value="sam">sam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
65 <option value="bam">bam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
66 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
67 <repeat name="input_list" title="fastq.gz input datasets" default="1" min="1">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
68 <param format="data" name="file1" type="data" label="inputfile 1"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
69 <param format="data" name="file2" type="data" label="inputfile 2"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
70 </repeat>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
71 </when>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
72 <when value="sam">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
73 <param name="oformat" type="select" label="choose the output file format">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
74 <option value="bam">bam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
75 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
76 <repeat name="input_list" title="sam input dataset" default="1" min="1" max="1">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
77 <param name="file1" format="sam" type="data" label="inputfile"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
78 </repeat>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
79 </when>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
80 <when value="bam">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
81 <param name="oformat" type="select" label="choose the output file format">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
82 <option value="sam">sam</option>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
83 </param>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
84 <repeat name="input_list" title="bam input dataset" default="1" min="1" max="1">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
85 <param name="file1" format="bam" type="data" label="inputfile"/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
86 </repeat>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
87 </when>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
88 </conditional>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
89 <param name="header" type="data" format="sam" optional="True" 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. Selection is highly recommended."/>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
90 </inputs>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
91
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
92 <outputs>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
93 <data name="outputname" format="bam" label="Converted reads from MiModd ${tool.name} on ${on_string}">
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
94 <change_format>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
95 <when input="mode.oformat" value="sam" format="sam" />
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
96 </change_format>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
97 </data>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
98 </outputs>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
99
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
100 <help>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
101 .. class:: infomark
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
102
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
103 **What it does**
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
104
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
105 The tool converts between different file formats used for storing next-generation sequencing data.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
106
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
107 As input file types, it can handle uncompressed or gzipped fastq, SAM or BAM format, which it can convert to SAM or BAM format.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
108
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
109 **Notes:**
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
110
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
111 1) In its standard configuration Galaxy will decompress any .gz files during their upload, effectively preventing the use of gzipped fastq files.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
112
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
113 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.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
114
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
115 **TIP:** If your paired-end data is arranged differently, you may look into the *FASTQ splitter* and *FASTQ de-interlacer* tools to see if they convert your files to the right format.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
116
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
117 3) Specifying a SAM header file to use in the conversion is highly recommended as this will add sequencing run metadata to the results file, which is the main purpose of storing unaligned NGS data in SAM/BAM format.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
118
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
119 See the help on the *NGS Run Annotation* tool for information on how to generate a new header file.
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
120
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
121 </help>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
122
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
123 </tool>
7da2c9654a83 Uploaded
wolma
parents:
diff changeset
124