annotate edge_pro.xml @ 2:bad8a51514dd draft

Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
author crs4
date Wed, 05 Mar 2014 06:44:35 -0500
parents f77ce4f92b46
children ddcbf8732706
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
1 <tool id="edge_pro" name="EDGE-pro" version="1.0.1">
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
2 <description>Gene expression in Prokaryotes</description>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
3 <requirements>
1
f77ce4f92b46 Use $GALAXY_SLOTS instead of $EDGE_PRO_SITE_OPTIONS. Add dependency on bowtie2. Add readme.rst .
crs4
parents: 0
diff changeset
4 <requirement type="package" version="2.1.0">bowtie2</requirement>
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
5 <requirement type="package" version="1.3.1">edge-pro</requirement>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
6 </requirements>
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
7 <command>
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
8 edge.pl -t \${GALAXY_SLOTS:-4} -o edge_out
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
9 ## Mandatory input parameters
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
10 -g $genome
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
11 -p $ptt
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
12 -r $rnt
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
13 ## First input file always required
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
14 -u $singlePaired.input1
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
15 ## Second input only if input is paired-end
7af33315bc5e Uploaded
crs4
parents:
diff changeset
16 #if $singlePaired.sPaired == "paired"
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
17 -v $singlePaired.input2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
18 #if str($singlePaired.minInsertSize)
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
19 -m $singlePaired.minInsertSize
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
20 #end if
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
21 #if str($singlePaired.maxInsertSize)
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
22 -M $singlePaired.maxInsertSize
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
23 #end if
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
24 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
25
7af33315bc5e Uploaded
crs4
parents:
diff changeset
26 ## Optional input parameters
7af33315bc5e Uploaded
crs4
parents:
diff changeset
27 #if $params.settingsType == "full"
7af33315bc5e Uploaded
crs4
parents:
diff changeset
28 #if str($params.window)
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
29 -w $params.window
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
30 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
31 #if str($params.utrSize)
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
32 -i $params.utrSize
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
33 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
34 #if str($params.similarity)
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
35 -x $params.similarity
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
36 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
37 #if str($params.readLength)
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
38 -l $params.readLength
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
39 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
40 #if str($params.minCoverage)
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
41 -c $params.minCoverage
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
42 #end if
7af33315bc5e Uploaded
crs4
parents:
diff changeset
43 #end if
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
44 &gt; $out_log 2&gt;&amp;1 ## need to redirect stderr because edge.pl calls bowtie2 and count which write some logging info there
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
45 &amp;&amp; cat edge_out.rpkm_* > $out_rpkm
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
46 </command>
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
47 <stdio>
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
48 <exit_code range="1:" level="fatal" />
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
49 </stdio>
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
50 <inputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
51 <conditional name="singlePaired">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
52 <param name="sPaired" type="select" label="Is this library mate-paired?">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
53 <option value="single">Single-end</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
54 <option value="paired">Paired-end</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
55 </param>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
56 <when value="single">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
57 <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
58 </when>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
59 <when value="paired">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
60 <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
61 <param format="fastqsanger" name="input2" type="data" label="Reverse FASTQ file" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)" />
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
62 <param name="minInsertSize" type="integer" optional="true" min="0" value="0" label="Minimun insert size in paired-end library for Bowtie2 (-m)" />
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
63 <param name="maxInsertSize" type="integer" optional="true" min="1" value="500" label="Maximun insert size in paired-end library for Bowtie2 (-M)" />
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
64 </when>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
65 </conditional>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
66
7af33315bc5e Uploaded
crs4
parents:
diff changeset
67 <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
68 <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
69 <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
70
7af33315bc5e Uploaded
crs4
parents:
diff changeset
71 <conditional name="params">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
72 <param name="settingsType" type="select" label="Parameter settings" help="For most needs, use default settings. If you want full control use Full Parameter List">
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
73 <option value="preSet">Use defaults</option>
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
74 <option value="full">Full parameter list</option>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
75 </param>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
76 <when value="preSet" />
7af33315bc5e Uploaded
crs4
parents:
diff changeset
77 <when value="full">
7af33315bc5e Uploaded
crs4
parents:
diff changeset
78 <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
79 <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
80 <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
81 <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
82 <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" />
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
83 </when>
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
84 </conditional>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
85 </inputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
86
7af33315bc5e Uploaded
crs4
parents:
diff changeset
87 <outputs>
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
88 <data format="sam" name="out_aln" label="${tool.name} on ${on_string}: alignment" from_work_dir="edge_out.alignments" />
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
89 <data format="tabular" name="out_rpkm" label="${tool.name} on ${on_string}: rpkm"/>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
90 <data format="txt" name="out_log" label="${tool.name} on ${on_string}: log"/>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
91 </outputs>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
92
7af33315bc5e Uploaded
crs4
parents:
diff changeset
93 <help>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
94
7af33315bc5e Uploaded
crs4
parents:
diff changeset
95 **What it does**
7af33315bc5e Uploaded
crs4
parents:
diff changeset
96
7af33315bc5e Uploaded
crs4
parents:
diff changeset
97 `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
98 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
99
7af33315bc5e Uploaded
crs4
parents:
diff changeset
100 **Input files:**
7af33315bc5e Uploaded
crs4
parents:
diff changeset
101
7af33315bc5e Uploaded
crs4
parents:
diff changeset
102 .. class:: infomark
7af33315bc5e Uploaded
crs4
parents:
diff changeset
103
7af33315bc5e Uploaded
crs4
parents:
diff changeset
104 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
105 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
106
7af33315bc5e Uploaded
crs4
parents:
diff changeset
107 .. _NCBI ftp repository: ftp://ftp.ncbi.nlm.nih.gov/genomes/Bacteria/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
108
7af33315bc5e Uploaded
crs4
parents:
diff changeset
109 .. class:: warningmark
7af33315bc5e Uploaded
crs4
parents:
diff changeset
110
7af33315bc5e Uploaded
crs4
parents:
diff changeset
111 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
112
7af33315bc5e Uploaded
crs4
parents:
diff changeset
113 **License and citation**
7af33315bc5e Uploaded
crs4
parents:
diff changeset
114
7af33315bc5e Uploaded
crs4
parents:
diff changeset
115 This Galaxy tool is Copyright © 2012-2013 `CRS4 Srl.`_ and is released under the `MIT license`_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
116
7af33315bc5e Uploaded
crs4
parents:
diff changeset
117 .. _CRS4 Srl.: http://www.crs4.it/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
118 .. _MIT license: http://opensource.org/licenses/MIT
7af33315bc5e Uploaded
crs4
parents:
diff changeset
119
7af33315bc5e Uploaded
crs4
parents:
diff changeset
120 If you use this tool in Galaxy, please cite |Cuccuru2013|_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
121
2
bad8a51514dd Directly call edge.pl, remove edge_pro.py . Move minimun and maximum insert size params to paired library section. Update Orione citation.
crs4
parents: 1
diff changeset
122 .. |Cuccuru2013| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2014) Orione, a web-based framework for NGS analysis in microbiology. *Bioinformatics*, accepted
0
7af33315bc5e Uploaded
crs4
parents:
diff changeset
123 .. _Cuccuru2013: http://orione.crs4.it/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
124
7af33315bc5e Uploaded
crs4
parents:
diff changeset
125 This tool uses `EDGE-pro`_, which is licensed separately. Please cite |Magoc2013|_.
7af33315bc5e Uploaded
crs4
parents:
diff changeset
126
7af33315bc5e Uploaded
crs4
parents:
diff changeset
127 .. _EDGE-pro: http://ccb.jhu.edu/software/EDGE-pro/
7af33315bc5e Uploaded
crs4
parents:
diff changeset
128 .. |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
129 .. _Magoc2013: http://www.la-press.com/edge-pro-estimated-degree-of-gene-expression-in-prokaryotic-genomes-article-a3586
7af33315bc5e Uploaded
crs4
parents:
diff changeset
130 </help>
7af33315bc5e Uploaded
crs4
parents:
diff changeset
131 </tool>