annotate edge_pro.xml @ 0:7af33315bc5e draft

Uploaded
author crs4
date Mon, 09 Sep 2013 06:11:47 -0400
parents
children f77ce4f92b46
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
1 <tool id="edge_pro" name="EDGE-pro" version="1.0.0">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
2 <description>Gene expression in Prokaryotes</description>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
3 <requirements>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
4 <requirement type="package" version="1.3.1">edge-pro</requirement>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
5 </requirements>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
6 <command interpreter="python">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
7 edge_pro.py
7af33315bc5e Uploaded
crs4
parents:
diff changeset
8 \${EDGE_PRO_SITE_OPTIONS:---num-threads=4}
7af33315bc5e Uploaded
crs4
parents:
diff changeset
9
7af33315bc5e Uploaded
crs4
parents:
diff changeset
10 ## Mandatory input parameters
7af33315bc5e Uploaded
crs4
parents:
diff changeset
11 --genome $genome
7af33315bc5e Uploaded
crs4
parents:
diff changeset
12 --ptt $ptt
7af33315bc5e Uploaded
crs4
parents:
diff changeset
13 --rnt $rnt
7af33315bc5e Uploaded
crs4
parents:
diff changeset
14 ## First input file always required
7af33315bc5e Uploaded
crs4
parents:
diff changeset
15 --input1 $singlePaired.input1
7af33315bc5e Uploaded
crs4
parents:
diff changeset
16 ## Second input only if input is paired-end
7af33315bc5e Uploaded
crs4
parents:
diff changeset
17 #if $singlePaired.sPaired == "paired"
7af33315bc5e Uploaded
crs4
parents:
diff changeset
18 --input2=$singlePaired.input2
7af33315bc5e Uploaded
crs4
parents:
diff changeset
19 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
20
7af33315bc5e Uploaded
crs4
parents:
diff changeset
21 ## Optional input parameters
7af33315bc5e Uploaded
crs4
parents:
diff changeset
22 #if $params.settingsType == "full"
7af33315bc5e Uploaded
crs4
parents:
diff changeset
23 #if str($params.minInsertSize)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
24 --minInsertSize=$params.minInsertSize
7af33315bc5e Uploaded
crs4
parents:
diff changeset
25 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
26 #if str($params.maxInsertSize)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
27 --maxInsertSize=$params.maxInsertSize
7af33315bc5e Uploaded
crs4
parents:
diff changeset
28 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
29 #if str($params.window)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
30 --window=$params.window
7af33315bc5e Uploaded
crs4
parents:
diff changeset
31 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
32 #if str($params.utrSize)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
33 --utrSize=$params.utrSize
7af33315bc5e Uploaded
crs4
parents:
diff changeset
34 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
35 #if str($params.similarity)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
36 --similarity=$params.similarity
7af33315bc5e Uploaded
crs4
parents:
diff changeset
37 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
38 #if str($params.readLength)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
39 --readLength=$params.readLength
7af33315bc5e Uploaded
crs4
parents:
diff changeset
40 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
41 #if str($params.minCoverage)
7af33315bc5e Uploaded
crs4
parents:
diff changeset
42 --minCoverage=$params.minCoverage
7af33315bc5e Uploaded
crs4
parents:
diff changeset
43 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
44 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
45
7af33315bc5e Uploaded
crs4
parents:
diff changeset
46 ## Outputs
7af33315bc5e Uploaded
crs4
parents:
diff changeset
47 --out-aln $out_aln
7af33315bc5e Uploaded
crs4
parents:
diff changeset
48 --out-rpkm $out_rpkm
7af33315bc5e Uploaded
crs4
parents:
diff changeset
49 --out-log $out_log
7af33315bc5e Uploaded
crs4
parents:
diff changeset
50 </command>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
51 <inputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
52 <conditional name="singlePaired">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
53 <param name="sPaired" type="select" label="Is this library mate-paired?">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
54 <option value="single">Single-end</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
55 <option value="paired">Paired-end</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
56 </param>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
57 <when value="single">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
58 <param format="fastqsanger" name="input1" type="data" label="FASTQ file" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)"/>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
59 </when>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
60 <when value="paired">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
61 <param format="fastqsanger" name="input1" type="data" label="Forward FASTQ file" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
62 <param format="fastqsanger" name="input2" type="data" label="Reverse FASTQ file" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
63 </when>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
64 </conditional>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
65
7af33315bc5e Uploaded
crs4
parents:
diff changeset
66 <param format="fasta" name="genome" type="data" label="Select the reference genome from your history (-g)" help="FASTA format" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
67 <param format="ptt" name="ptt" type="data" label="Coordinates of coding genes (PTT file)" help="PTT file with coordinates of coding genes (-p)" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
68 <param format="rnt" name="rnt" type="data" label="Coordinates of structural RNAs (RNT file)" help="RNT file with coordinates of structural RNA (-r)" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
69
7af33315bc5e Uploaded
crs4
parents:
diff changeset
70 <conditional name="params">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
71 <param name="settingsType" type="select" label="Parameter settings" help="For most needs, use default settings. If you want full control use Full Parameter List">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
72 <option value="preSet">Use Defaults</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
73 <option value="full">Full parameter list</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
74 </param>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
75 <when value="preSet" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
76 <!-- Full/advanced params. -->
7af33315bc5e Uploaded
crs4
parents:
diff changeset
77 <when value="full">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
78 <param name="minInsertSize" type="integer" optional="true" value="0" label="Minimun insert size for a read pair (-m)" help="For paired-end reads only" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
79 <param name="maxInsertSize" type="integer" optional="true" value="500" label="Maximun insert size for a read pair (-M)" help="For paired-end reads only" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
80 <param name="window" type="integer" optional="true" value="100" label="Window length for coverage distribution (-w)" help="Used to distribute the coverage between two overlapping genes. See help below for details" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
81 <param name="utrSize" type="integer" optional="true" value="40" label="Size of the untranslated region (-i)" help="Enter the size of the untranslated region between the initial transcription site and the start codon" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
82 <param name="similarity" type="float" optional="true" value="0.15" label="Percentage for similar coverage (-x)" help="Enter the percentage used to determine when two coverage values are considered similar. See help below for details" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
83 <param name="readLength" type="integer" optional="true" value="" label="Read length (-l)" help="If not specified, the first 1000 reads are used to approximate the read length" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
84 <param name="minCoverage" type="integer" optional="true" value="3" label="Minimum average coverage for expressed genes (-c)" help="Coverage less than specified is assumed to be noise and gene is considered to not be expressed" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
85 </when> <!-- full -->
7af33315bc5e Uploaded
crs4
parents:
diff changeset
86 </conditional>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
87 </inputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
88
7af33315bc5e Uploaded
crs4
parents:
diff changeset
89 <outputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
90 <data format="sam" name="out_aln" label="${tool.name} on ${on_string}: alignment"/>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
91 <data format="tabular" name="out_rpkm" label="${tool.name} on ${on_string}: rpkm"/>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
92 <data format="txt" name="out_log" label="${tool.name} on ${on_string}: log"/>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
93 </outputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
94
7af33315bc5e Uploaded
crs4
parents:
diff changeset
95 <help>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
96
7af33315bc5e Uploaded
crs4
parents:
diff changeset
97 **What it does**
7af33315bc5e Uploaded
crs4
parents:
diff changeset
98
7af33315bc5e Uploaded
crs4
parents:
diff changeset
99 `EDGE-pro`_, Estimated Degree of Gene Expression in PROkaryots is an efficient software system to estimate gene expression levels in prokaryotic genomes from RNA-seq data. EDGE-pro uses Bowtie2 for alignment and then estimates expression directly from the alignment results.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
100 EDGE-pro includes routines to assign reads aligning to overlapping gene regions accurately. 15% or more of bacterial genes overlap other genes, making this a significant problem for bacterial RNA-seq, one that is generally ignored by programs designed for eukaryotic RNA-seq experiments.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
101
7af33315bc5e Uploaded
crs4
parents:
diff changeset
102 **Input files:**
7af33315bc5e Uploaded
crs4
parents:
diff changeset
103
7af33315bc5e Uploaded
crs4
parents:
diff changeset
104 .. class:: infomark
7af33315bc5e Uploaded
crs4
parents:
diff changeset
105
7af33315bc5e Uploaded
crs4
parents:
diff changeset
106 Input files with gene coordinates in PTT and RNT format can be retrieved with the Get EDGE-pro Files tool available in Galaxy, or downloaded from the `NCBI ftp repository`_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
107 This tool accepts files in Sanger FASTQ format (Galaxy *fastqsanger* datatype). Use the FASTQ Groomer tool to prepare your files.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
108
7af33315bc5e Uploaded
crs4
parents:
diff changeset
109 .. _NCBI ftp repository: ftp://ftp.ncbi.nlm.nih.gov/genomes/Bacteria/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
110
7af33315bc5e Uploaded
crs4
parents:
diff changeset
111 .. class:: warningmark
7af33315bc5e Uploaded
crs4
parents:
diff changeset
112
7af33315bc5e Uploaded
crs4
parents:
diff changeset
113 All 3 types of files (FASTA reference genome, PTT and RNT) must have the same order of chromosomes/plasmids (e.g. if chr1 is before chr2 in genome.fasta file, then chr1 must be before chr2 in ptt and rnt files as well). If there is no PTT or RNT file for one of chromosomes/plasmids, place this chromosome/plasmid at the end of the file.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
114
7af33315bc5e Uploaded
crs4
parents:
diff changeset
115 **License and citation**
7af33315bc5e Uploaded
crs4
parents:
diff changeset
116
7af33315bc5e Uploaded
crs4
parents:
diff changeset
117 This Galaxy tool is Copyright © 2012-2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
118
7af33315bc5e Uploaded
crs4
parents:
diff changeset
119 .. _CRS4 Srl.: http://www.crs4.it/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
120 .. _MIT license: http://opensource.org/licenses/MIT
7af33315bc5e Uploaded
crs4
parents:
diff changeset
121
7af33315bc5e Uploaded
crs4
parents:
diff changeset
122 If you use this tool in Galaxy, please cite |Cuccuru2013|_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
123
7af33315bc5e Uploaded
crs4
parents:
diff changeset
124 .. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2013) Orione, a web-based framework for NGS analysis in microbiology. *Submitted*
7af33315bc5e Uploaded
crs4
parents:
diff changeset
125 .. _Cuccuru2013: http://orione.crs4.it/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
126
7af33315bc5e Uploaded
crs4
parents:
diff changeset
127 This tool uses `EDGE-pro`_, which is licensed separately. Please cite |Magoc2013|_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
128
7af33315bc5e Uploaded
crs4
parents:
diff changeset
129 .. _EDGE-pro: http://ccb.jhu.edu/software/EDGE-pro/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
130 .. |Magoc2013| replace:: Magoc, T., Wood, D., Salzberg, S. L. (2013) EDGE-pro: Estimated Degree of Gene Expression in Prokaryotic Genomes. *Evol. Bioinform.* 2013:9, 127-136
7af33315bc5e Uploaded
crs4
parents:
diff changeset
131 .. _Magoc2013: http://www.la-press.com/edge-pro-estimated-degree-of-gene-expression-in-prokaryotic-genomes-article-a3586
7af33315bc5e Uploaded
crs4
parents:
diff changeset
132 </help>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
133 </tool>