Mercurial > repos > crs4 > edge_pro
annotate edge_pro.xml @ 4:d5464c9e1723 draft
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
| author | crs4 |
|---|---|
| date | Tue, 17 Mar 2015 10:44:33 -0400 |
| parents | ddcbf8732706 |
| children | e6e6f5f9b9c4 |
| 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 | 2 <description>Gene expression in Prokaryotes</description> |
| 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 | 5 <requirement type="package" version="1.3.1">edge-pro</requirement> |
| 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 | 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 |
|
4
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
13 |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
14 #if $singlePaired.sPaired == "single" |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
15 -u $singlePaired.input1 |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
16 #else if $singlePaired.sPaired == "paired" |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
17 -u $singlePaired.input1 |
|
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
|
18 -v $singlePaired.input2 |
|
4
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
19 #else if $singlePaired.sPaired == "pairedCollection" |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
20 -u $singlePaired.input.forward |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
21 -v $singlePaired.input.reverse |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
22 #end if |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
23 |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
24 #if $singlePaired.sPaired in ["paired", "pairedCollection"] |
|
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
|
25 #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
|
26 -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
|
27 #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
|
28 #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
|
29 -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
|
30 #end if |
| 0 | 31 #end if |
| 32 | |
| 33 ## Optional input parameters | |
| 34 #if $params.settingsType == "full" | |
| 35 #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
|
36 -w $params.window |
| 0 | 37 #end if |
| 38 #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
|
39 -i $params.utrSize |
| 0 | 40 #end if |
| 41 #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
|
42 -x $params.similarity |
| 0 | 43 #end if |
| 44 #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
|
45 -l $params.readLength |
| 0 | 46 #end if |
| 47 #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
|
48 -c $params.minCoverage |
| 0 | 49 #end if |
| 50 #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
|
51 > $out_log 2>&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
|
52 && cat edge_out.rpkm_* > $out_rpkm |
| 0 | 53 </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
|
54 <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
|
55 <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
|
56 </stdio> |
| 0 | 57 <inputs> |
| 58 <conditional name="singlePaired"> | |
| 59 <param name="sPaired" type="select" label="Is this library mate-paired?"> | |
| 60 <option value="single">Single-end</option> | |
| 61 <option value="paired">Paired-end</option> | |
|
4
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
62 <option value="pairedCollection">Paired-end collection</option> |
| 0 | 63 </param> |
| 64 <when value="single"> | |
| 65 <param format="fastqsanger" name="input1" type="data" label="FASTQ file" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)"/> | |
| 66 </when> | |
| 67 <when value="paired"> | |
| 68 <param format="fastqsanger" name="input1" type="data" label="Forward FASTQ file" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)" /> | |
| 69 <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
|
70 <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
|
71 <param name="maxInsertSize" type="integer" optional="true" min="1" value="500" label="Maximun insert size in paired-end library for Bowtie2 (-M)" /> |
| 0 | 72 </when> |
|
4
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
73 <when value="pairedCollection"> |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
74 <param format="fastqsanger" name="input" type="data_collection" collection_type="paired" label="FASTQ paired collection" help="FASTQ format with Sanger-scaled quality values (Galaxy fastqsanger datatype)" /> |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
75 <param name="minInsertSize" type="integer" optional="true" min="0" value="0" label="Minimun insert size in paired-end library for Bowtie2 (-m)" /> |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
76 <param name="maxInsertSize" type="integer" optional="true" min="1" value="500" label="Maximun insert size in paired-end library for Bowtie2 (-M)" /> |
|
d5464c9e1723
Add support for paired collection of FASTQ (thanks to Inge Alexander Raknes).
crs4
parents:
3
diff
changeset
|
77 </when> |
| 0 | 78 </conditional> |
| 79 | |
| 80 <param format="fasta" name="genome" type="data" label="Select the reference genome from your history (-g)" help="FASTA format" /> | |
| 81 <param format="ptt" name="ptt" type="data" label="Coordinates of coding genes (PTT file)" help="PTT file with coordinates of coding genes (-p)" /> | |
| 82 <param format="rnt" name="rnt" type="data" label="Coordinates of structural RNAs (RNT file)" help="RNT file with coordinates of structural RNA (-r)" /> | |
| 83 | |
| 84 <conditional name="params"> | |
| 85 <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
|
86 <option value="preSet">Use defaults</option> |
| 0 | 87 <option value="full">Full parameter list</option> |
| 88 </param> | |
| 89 <when value="preSet" /> | |
| 90 <when value="full"> | |
| 91 <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" /> | |
| 92 <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" /> | |
| 93 <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" /> | |
| 94 <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" /> | |
| 95 <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
|
96 </when> |
| 0 | 97 </conditional> |
| 98 </inputs> | |
| 99 | |
| 100 <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
|
101 <data format="sam" name="out_aln" label="${tool.name} on ${on_string}: alignment" from_work_dir="edge_out.alignments" /> |
| 0 | 102 <data format="tabular" name="out_rpkm" label="${tool.name} on ${on_string}: rpkm"/> |
| 103 <data format="txt" name="out_log" label="${tool.name} on ${on_string}: log"/> | |
| 104 </outputs> | |
| 105 | |
| 106 <help> | |
| 107 | |
| 108 **What it does** | |
| 109 | |
| 110 `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. | |
| 111 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. | |
| 112 | |
| 113 **Input files:** | |
| 114 | |
| 115 .. class:: infomark | |
| 116 | |
| 117 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`_. | |
| 118 This tool accepts files in Sanger FASTQ format (Galaxy *fastqsanger* datatype). Use the FASTQ Groomer tool to prepare your files. | |
| 119 | |
| 120 .. _NCBI ftp repository: ftp://ftp.ncbi.nlm.nih.gov/genomes/Bacteria/ | |
| 121 | |
| 122 .. class:: warningmark | |
| 123 | |
| 124 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. | |
| 125 | |
| 126 **License and citation** | |
| 127 | |
|
3
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
128 This Galaxy tool is Copyright © 2012-2014 `CRS4 Srl.`_ and is released under the `MIT license`_. |
| 0 | 129 |
| 130 .. _CRS4 Srl.: http://www.crs4.it/ | |
| 131 .. _MIT license: http://opensource.org/licenses/MIT | |
| 132 | |
|
3
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
133 You can use this tool only if you agree to the license terms of: `EDGE-pro`_. |
| 0 | 134 |
| 135 .. _EDGE-pro: http://ccb.jhu.edu/software/EDGE-pro/ | |
|
3
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
136 |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
137 If you use this tool, please cite: |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
138 |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
139 - |Cuccuru2014|_ |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
140 - |Magoc2013|_. |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
141 |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
142 .. |Cuccuru2014| 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* 30(13), 1928-1929 |
|
ddcbf8732706
Fix edge-pro tool dependency (uninstall and install again the tool dependency if you were encountering errors like 'Can't exec "./bowtie2-build": No such file or directory'). Update Orione citation.
crs4
parents:
2
diff
changeset
|
143 .. _Cuccuru2014: http://bioinformatics.oxfordjournals.org/content/30/13/1928 |
| 0 | 144 .. |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 |
| 145 .. _Magoc2013: http://www.la-press.com/edge-pro-estimated-degree-of-gene-expression-in-prokaryotic-genomes-article-a3586 | |
| 146 </help> | |
| 147 </tool> |