annotate predict/predict_RNAs.xml @ 108:59862169c998 draft

Uploaded
author tyty
date Mon, 23 Mar 2015 16:54:13 -0400
parents
children 4e13117db219
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
108
59862169c998 Uploaded
tyty
parents:
diff changeset
1 <tool id="predict_pipeline" name="RNA Structure Prediction" version="1.0">
59862169c998 Uploaded
tyty
parents:
diff changeset
2 <description>predict RNA structures with or without experimental constraints from the Reactivity Calculation module</description>
59862169c998 Uploaded
tyty
parents:
diff changeset
3 <command interpreter="python">
59862169c998 Uploaded
tyty
parents:
diff changeset
4 #if $program.wh == "rs"
59862169c998 Uploaded
tyty
parents:
diff changeset
5 #if $program.rs_reactivity.type == "restraint"
59862169c998 Uploaded
tyty
parents:
diff changeset
6 predict_RNAs.py $rna_list $reference_file $program.rs_reactivity.type $temperature $program.wh $output $program.rs_reactivity.reactivity_file $program.rs_reactivity.slope $program.rs_reactivity.intercept
59862169c998 Uploaded
tyty
parents:
diff changeset
7 #else
59862169c998 Uploaded
tyty
parents:
diff changeset
8 predict_RNAs.py $rna_list $reference_file $program.rs_reactivity.type $temperature $program.wh $output
59862169c998 Uploaded
tyty
parents:
diff changeset
9 #end if
59862169c998 Uploaded
tyty
parents:
diff changeset
10 #else
59862169c998 Uploaded
tyty
parents:
diff changeset
11 #if $program.vp_reactivity.type == "restraint"
59862169c998 Uploaded
tyty
parents:
diff changeset
12 predict_RNAs.py $rna_list $reference_file $program.vp_reactivity.type $temperature $program.wh $output $program.vp_reactivity.reactivity_file $program.vp_reactivity.threshold_high $program.vp_reactivity.threshold_low $program.gqs
59862169c998 Uploaded
tyty
parents:
diff changeset
13 #else
59862169c998 Uploaded
tyty
parents:
diff changeset
14 predict_RNAs.py $rna_list $reference_file $program.vp_reactivity.type $temperature $program.wh $output $program.gqs
59862169c998 Uploaded
tyty
parents:
diff changeset
15 #end if
59862169c998 Uploaded
tyty
parents:
diff changeset
16 #end if
59862169c998 Uploaded
tyty
parents:
diff changeset
17 </command>
59862169c998 Uploaded
tyty
parents:
diff changeset
18 <stdio>
59862169c998 Uploaded
tyty
parents:
diff changeset
19 <exit_code range="1:" />
59862169c998 Uploaded
tyty
parents:
diff changeset
20 <exit_code range=":-1" />
59862169c998 Uploaded
tyty
parents:
diff changeset
21 <regex match="Error:" />
59862169c998 Uploaded
tyty
parents:
diff changeset
22 <regex match="Exception:" />
59862169c998 Uploaded
tyty
parents:
diff changeset
23 </stdio>
59862169c998 Uploaded
tyty
parents:
diff changeset
24 <requirements>
59862169c998 Uploaded
tyty
parents:
diff changeset
25 <requirement type="package" version="1.61">biopython</requirement>
59862169c998 Uploaded
tyty
parents:
diff changeset
26 <requirement type="package" version="1.7.1">numpy</requirement>
59862169c998 Uploaded
tyty
parents:
diff changeset
27 <requirement type="package" version="1.2.1">matplotlib</requirement>
59862169c998 Uploaded
tyty
parents:
diff changeset
28 </requirements>
59862169c998 Uploaded
tyty
parents:
diff changeset
29 <inputs>
59862169c998 Uploaded
tyty
parents:
diff changeset
30 <param name="rna_list" type="data" format="txt" label="List of RNA ids to predict"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
31 <param name="reference_file" type="data" format="fasta" label="Reference genome/transcriptome"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
32 <param name="temperature" type="float" value="310.15" label="Temperature (K)"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
33 <conditional name="program">
59862169c998 Uploaded
tyty
parents:
diff changeset
34 <param name="wh" type="select" label="Program for RNA structure prediction">
59862169c998 Uploaded
tyty
parents:
diff changeset
35 <option value="rs">RNAstructure</option>
59862169c998 Uploaded
tyty
parents:
diff changeset
36 <option value="vp">ViennaRNA Package</option>
59862169c998 Uploaded
tyty
parents:
diff changeset
37 </param>
59862169c998 Uploaded
tyty
parents:
diff changeset
38 <when value="rs">
59862169c998 Uploaded
tyty
parents:
diff changeset
39 <conditional name="rs_reactivity">
59862169c998 Uploaded
tyty
parents:
diff changeset
40 <param name="type" type="select" label="RNA structure prediction type">
59862169c998 Uploaded
tyty
parents:
diff changeset
41 <option value="silico">In silico</option>
59862169c998 Uploaded
tyty
parents:
diff changeset
42 <option value="restraint">With experimental restraints</option>
59862169c998 Uploaded
tyty
parents:
diff changeset
43 </param>
59862169c998 Uploaded
tyty
parents:
diff changeset
44 <when value="silico"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
45 <when value="restraint">
59862169c998 Uploaded
tyty
parents:
diff changeset
46 <param name="reactivity_file" type="data" label="Reactivity file"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
47 <param name="slope" type="float" value="1.8" label="Slope used with structural restraints"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
48 <param name="intercept" type="float" value="-0.6" label="Intercept used with structural restraints"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
49 </when>
59862169c998 Uploaded
tyty
parents:
diff changeset
50 </conditional>
59862169c998 Uploaded
tyty
parents:
diff changeset
51 </when>
59862169c998 Uploaded
tyty
parents:
diff changeset
52 <when value="vp">
59862169c998 Uploaded
tyty
parents:
diff changeset
53 <conditional name="vp_reactivity">
59862169c998 Uploaded
tyty
parents:
diff changeset
54 <param name="type" type="select" label="RNA structure prediction type">
59862169c998 Uploaded
tyty
parents:
diff changeset
55 <option value="silico">In silico</option>
59862169c998 Uploaded
tyty
parents:
diff changeset
56 <option value="restraint">With experimental restraints</option>
59862169c998 Uploaded
tyty
parents:
diff changeset
57 </param>
59862169c998 Uploaded
tyty
parents:
diff changeset
58 <when value="silico"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
59 <when value="restraint">
59862169c998 Uploaded
tyty
parents:
diff changeset
60 <param name="reactivity_file" type="data" label="Reactivity file"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
61 <param name="threshold_high" type="float" value="0.6" label="Threshold for high reactivities"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
62 <param name="threshold_low" type="float" value="0.3" label="Threshold for low reactivities"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
63 </when>
59862169c998 Uploaded
tyty
parents:
diff changeset
64 </conditional>
59862169c998 Uploaded
tyty
parents:
diff changeset
65 <param name="gqs" type="boolean" checked="false" truevalue = "1" falsevalue = "0" label="Incoorporate G-Quadruplex prediction if checked"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
66 </when>
59862169c998 Uploaded
tyty
parents:
diff changeset
67 </conditional>
59862169c998 Uploaded
tyty
parents:
diff changeset
68
59862169c998 Uploaded
tyty
parents:
diff changeset
69
59862169c998 Uploaded
tyty
parents:
diff changeset
70 </inputs>
59862169c998 Uploaded
tyty
parents:
diff changeset
71 <outputs>
59862169c998 Uploaded
tyty
parents:
diff changeset
72 <data name="output" format=".tar"/>
59862169c998 Uploaded
tyty
parents:
diff changeset
73 </outputs>
59862169c998 Uploaded
tyty
parents:
diff changeset
74
59862169c998 Uploaded
tyty
parents:
diff changeset
75 <help>
59862169c998 Uploaded
tyty
parents:
diff changeset
76
59862169c998 Uploaded
tyty
parents:
diff changeset
77
59862169c998 Uploaded
tyty
parents:
diff changeset
78 **Function**
59862169c998 Uploaded
tyty
parents:
diff changeset
79
59862169c998 Uploaded
tyty
parents:
diff changeset
80 RNA Structure Prediction uses the RNAstructure program (V5.6) and ViennaRNA package (V2.1.9) to predict RNA structures without restraints (in silico) or with restraints from structural reactivities, as provided by the Reactivity Calculation module. Users can designate the temperature under which to predict the RNA structures.
59862169c998 Uploaded
tyty
parents:
diff changeset
81
59862169c998 Uploaded
tyty
parents:
diff changeset
82 -----
59862169c998 Uploaded
tyty
parents:
diff changeset
83
59862169c998 Uploaded
tyty
parents:
diff changeset
84 **Input**:
59862169c998 Uploaded
tyty
parents:
diff changeset
85
59862169c998 Uploaded
tyty
parents:
diff changeset
86 * 1. A file with transcript Ids (Max num. 100), (each ID one line)
59862169c998 Uploaded
tyty
parents:
diff changeset
87 * 2. Reference file (fasta) used to map the reads to
59862169c998 Uploaded
tyty
parents:
diff changeset
88 * 3. Temperature for RNA structure prediction
59862169c998 Uploaded
tyty
parents:
diff changeset
89 * [Optional]:
59862169c998 Uploaded
tyty
parents:
diff changeset
90 * 1. A reactivity file with structural reactivity for each nucleotide on the sequence provided
59862169c998 Uploaded
tyty
parents:
diff changeset
91 * /RNAstructure prediction mode/
59862169c998 Uploaded
tyty
parents:
diff changeset
92 * 2. Slope used with structural restraints (default 1.8)
59862169c998 Uploaded
tyty
parents:
diff changeset
93 * 3. Intercept used with structural restraints (default -0.6)
59862169c998 Uploaded
tyty
parents:
diff changeset
94 * /ViennaRNA package prediction mode/
59862169c998 Uploaded
tyty
parents:
diff changeset
95 * 2. Flag that determines whether to incoorporate G-Quadruplex prediction
59862169c998 Uploaded
tyty
parents:
diff changeset
96 * 3. High reactivity threshold (Any nucleotide with structural reactivity that is higher than it will be constrainted as single stranded) (default 0.6)
59862169c998 Uploaded
tyty
parents:
diff changeset
97 * 4. Low reactivity threshold (Any nucleotide with structural reactivity that is lower than it will be constrainted as double stranded) (default 0.3)
59862169c998 Uploaded
tyty
parents:
diff changeset
98
59862169c998 Uploaded
tyty
parents:
diff changeset
99 -----
59862169c998 Uploaded
tyty
parents:
diff changeset
100
59862169c998 Uploaded
tyty
parents:
diff changeset
101 **Output**:
59862169c998 Uploaded
tyty
parents:
diff changeset
102
59862169c998 Uploaded
tyty
parents:
diff changeset
103 * 1. Dot bracket files with predicted RNA structures [transciptID.dbn]
59862169c998 Uploaded
tyty
parents:
diff changeset
104 * 2. .ps files which depict the predicted RNA structures [transciptID.ps]
59862169c998 Uploaded
tyty
parents:
diff changeset
105 * [Optional]
59862169c998 Uploaded
tyty
parents:
diff changeset
106 * 3. .png files that shows the distribution of the reactivity of each nucleotide on the transcripts of interest. [transciptID.png]
59862169c998 Uploaded
tyty
parents:
diff changeset
107
59862169c998 Uploaded
tyty
parents:
diff changeset
108 -----
59862169c998 Uploaded
tyty
parents:
diff changeset
109
59862169c998 Uploaded
tyty
parents:
diff changeset
110 **Attention**
59862169c998 Uploaded
tyty
parents:
diff changeset
111
59862169c998 Uploaded
tyty
parents:
diff changeset
112 Make sure that none of the transcript Ids contains a "|" or a space!
59862169c998 Uploaded
tyty
parents:
diff changeset
113
59862169c998 Uploaded
tyty
parents:
diff changeset
114 -----
59862169c998 Uploaded
tyty
parents:
diff changeset
115
59862169c998 Uploaded
tyty
parents:
diff changeset
116 **Backend program**:
59862169c998 Uploaded
tyty
parents:
diff changeset
117
59862169c998 Uploaded
tyty
parents:
diff changeset
118 * 1. This module uses RNAstructure (http://rna.urmc.rochester.edu/RNAstructure.html) or ViennaRNA package (http://www.tbi.univie.ac.at/RNA/) as the backend programs to predict RNA structures.
59862169c998 Uploaded
tyty
parents:
diff changeset
119 * 2. Default parameters are used for RNAstructure and ViennaRNA package except -T (Temperature), -sm (slope used with SHAPE restraints [RNAstructure prediction mode]), -si (intercept used with SHAPE restraints [RNAstructure prediction mode]) and thresholds for high and low reactivity [ViennaRNA package prediciton mode], for which users can specify the value
59862169c998 Uploaded
tyty
parents:
diff changeset
120
59862169c998 Uploaded
tyty
parents:
diff changeset
121
59862169c998 Uploaded
tyty
parents:
diff changeset
122
59862169c998 Uploaded
tyty
parents:
diff changeset
123 </help>
59862169c998 Uploaded
tyty
parents:
diff changeset
124 </tool>