annotate rnabob.xml @ 1:5a4b00c84f50 draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
author rnateam
date Sat, 11 Nov 2017 15:08:06 -0500
parents cd00b4fe6552
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
1 <tool id="rbc_rnabob" name="RNABOB" version="2.2.1.0">
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
2 <description>Fast Pattern searching for RNA secondary structures</description>
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
3
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
4 <requirements>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
5 <requirement type="package" version="2.2.1">rnabob</requirement>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
6 </requirements>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
7 <stdio>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
8 <exit_code range="1:" level="fatal" description="Error occurred. Please check Tool Standard Error" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
9 <exit_code range=":-1" level="fatal" description="Error occurred. Please check Tool Standard Error" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
10 </stdio>
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
11 <version_command>echo "2.2.1"</version_command>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
12 <command>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
13 <![CDATA[
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
14 rnabob
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
15 -q
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
16 $fancy
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
17 $compStrands
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
18 $skipOverlapping
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
19 $descriptorFile
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
20 $sequenceFile > $stdout
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
21 ]]>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
22 </command>
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
23 <inputs>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
24 <param name="descriptorFile" type="data" format="txt" multiple="false" label="Motif Descriptor File" help="This file contains the description of the motif for which to search"/>
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
25 <param name="sequenceFile" type="data" format="fasta" multiple="false" label="Sequence File" help="This file specifies the sequence in which the motif will be searched"/>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
26 <param name="compStrands" type="boolean" truevalue="-c" falsevalue="" checked="false" label="Also search on complementary strands" help="-c : Search both strands of the supplied sequence"/>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
27 <param name="skipOverlapping" type="boolean" truevalue="-s" falsevalue="" checked="false" label="Skip overlapping matches" help="-s : This is a workaround to avoid a problem in the DNABANK, overlapping matches will be ignored"/>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
28 <param name="fancy" type="boolean" checked="false" truevalue="-F" falsevalue="" label="Show Alignments" help="Display full alignments to pattern"/>
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
29 </inputs>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
30 <outputs>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
31 <data format="txt" name="stdout" label="${tool.name} on ${on_string}" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
32 </outputs>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
33 <tests>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
34 <test>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
35 <param name="descriptorFile" value="r17.des" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
36 <param name="sequenceFile" value="F22B7.fa" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
37 <param name="compStrands" value="True" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
38 <param name="skipOverlapping" value="False" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
39 <param name="fancy" value="False" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
40 <output name="stdout" file="r17.bob" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
41 </test>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
42 <test>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
43 <param name="descriptorFile" value="trna.des" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
44 <param name="sequenceFile" value="F22B7.fa" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
45 <param name="compStrands" value="True" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
46 <param name="skipOverlapping" value="False" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
47 <param name="fancy" value="False" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
48 <output name="stdout" file="trna.bob" />
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
49 </test>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
50 </tests>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
51 <help>
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
52 <![CDATA[
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
53 **What RNABOB does**
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
54
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
55 RNABOB allows searching a sequence database for RNA structural motifs.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
56 The probe motif is specified in a *descriptor* file,
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
57 which describes its primary sequence, secondary structure, and tertiary constraints.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
58 The source in its original packaging can be found at http://selab.janelia.org/software/#rnabob.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
59
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
60 -----
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
61
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
62 **Sequence database format**
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
63
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
64 RNABOB is currently restricted to reading sequence files in FASTA format.
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
65 The command line version of RNABOB can also read sequence files in GCG, EMBL, GenBank and other formats.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
66
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
67 -----
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
68
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
69 **Descriptor file syntax**
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
70
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
71 The descriptor file syntax is fairly powerful, and allows a great deal of freedom for specifying
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
72 RNA motifs. The syntax is therefore a bit complicated.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
73
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
74 The descriptor file has two parts: a **topology** description and an **explicit** description.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
75
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
76 The first non-blank, non-comment line of the file is the topology description. It defines the
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
77 order of occurrence of a series of single-stranded, double-stranded and related elements. Each
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
78 element must be given a unique name (a number, typically) and must be prefixed with '**s**',
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
79 '**h**', or '**r**', indicating single-strand, helical, or a relational element. Helical and
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
80 relational elements are paired to other elements, which are suffixed by a prime, **\'**.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
81
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
82 For example::
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
83
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
84 \
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
85 h1 s1 h1'
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
86
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
87 describes a hairpin loop structure with a simple helix and single-stranded loop. If the helix
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
88 always contained a non-canonical base pair at one position, the topology coud be described as::
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
89
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
90 \
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
91 h1 r1 h2 s1 h2' r1' h1'
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
92
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
93 where r1,r1' indicate a correlation, where the sequence r1 constrains the sequence of r1'.
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
94 (Helices are a special case of this.)
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
95
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
96 The remaining non-comment, non-blank lines are explicit descriptions of each element in turn. Each
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
97 line contains 3 or 4 fields, separated by tabs or blank space. The first field is the name of the
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
98 element, from the topology description. The second field is the number of mismatches allowed in
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
99 this element. The third field is the primary sequence constraint to apply to this element.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
100
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
101 Helices and relational element pairs are specified on a single line rather than two. Mismatches
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
102 and primary sequence constraints are given as pairs, separated by a colon '**:**'. The left side
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
103 is the constraint applied to the upstream element, and the right side is applied to the downstream
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
104 elements.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
105
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
106 The primary sequence constraint is given as a sequence of nucleotides. Any IUPAC single-letter
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
107 code is recognized, including N if the position can have any base identity. Allowed length
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
108 variations are specified with asterisks ``'*'``, where each ``*`` will allow either 0 or 1 N at
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
109 that position.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
110
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
111 For example::
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
112
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
113 \
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
114 GGAGG******NNNAUG
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
115
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
116 specifies a GGAGG Shine/Dalgarno site and an AUG initiation codon, separated by a spacer of 3 to 9
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
117 nucleotides of any sequence.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
118
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
119 An alternative syntax can be used for very long gaps::
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
120
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
121 \
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
122 GGAGG[10]NNNAUG is the same as GGAGG**********NNNAUG
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
123
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
124 Be careful defining variable length helices and relational elements; if the number and type (gap
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
125 or identity) of position do not match on left and right sides, the program will refuse to accept
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
126 the descriptor.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
127
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
128 Relational elements have an additional field which specifies a "transformation matrix" of four
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
129 nucleotides, specifying the rule for making the ``r'`` pattern from the ``r`` sequence in order
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
130 ``A-C-G-T``. For example, the transformation matrix for a simple helix is ``TGCA``; if you allow
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
131 ``G-U`` pairs, it is ``TGYR``. RNABOB allows ``G-U`` pairing by default and uses the ``TGYR``
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
132 matrix for helical elements.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
133
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
134 For example, the explicit description of our hairpin might be:
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
135
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
136 ::
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
137
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
138 \
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
139 h1 0:0 NNN:NNN
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
140 r1 0:0 R:N GNAN
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
141 h2 0:0 **NC:GN**
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
142 s1 0 UUCG
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
143
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
144 This describes a stem of 6 to 8 base pairs, in which the 4th pair from the bottom of the stem must
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
145 be a non-canonical GA pair. Note that, in general, the left side of the primary constraint for
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
146 helices and relational elements is redundant, and should be given as all N. In some cases it is
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
147 convenient to constrain the right side to require a particular base pair (GU, for instance) at one
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
148 position.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
149
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
150 A note on mismatches: The split format for helices and relational elements works like this. The
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
151 number on the left constrains the primary sequence match of the left side of the primary
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
152 constraint. The number on the right constrains the match of the right side of the primary
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
153 constraint, *after* that side has been constructed according to the sequence on the left. In other
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
154 words, the number on the left constrains the mismatches in primary sequence only, while the number
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
155 on the right will constrain the number of mispaired positions in the helix.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
156
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
157 Finally: any line that begins with a pound sign '#' is a comment line, and will not be interpreted
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
158 by the pattern compiler.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
159
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
160 **Options**
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
161
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
162 The behavior of RNABOB can be modified by use of the following options:
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
163
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
164 *Complement*: Selecting this option will cause RNABOB to search for the pattern also on the
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
165 complementary strands.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
166
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
167 *Skip*: This is a workaround to avoid a problem in the DNABANK. There are some sequences in the
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
168 database which have long stretches of ambiguous sequence (N's). Descriptors with no primary
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
169 sequence constraints will match these garbage sequences at many, many positions, and generate huge
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
170 outputs. This option toggles a search strategy that skips forward a pattern-length rather than a
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
171 single base when a match is found, thus printing out only a single match when overlapping matches
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
172 are found.
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
173
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
174 **Examples**
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
175
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
176 The following example descriptors included in the source distribution
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
177 (http://selab.janelia.org/software/rnabob/rnabob.tar.gz):
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
178
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
179 - trna.des - a general descriptor of a tRNA structure
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
180 - r17.des - descriptor of the consensus binding site for the r17 phage coat protein
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
181 - pseudoknot.des - description of a simple pseudoknotted structure
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
182
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
183 An example cosmid ``F22B7.fa`` from the *C. elegans* genome sequencing project is also provided
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
184 for running these descriptors against.
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
185
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
186 ::
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
187
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
188 \
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
189 # trna.des
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
190 #
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
191 # Generalized descriptor of a tRNA cloverleaf. Doesn't
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
192 # find them all though.
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
193 #
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
194
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
195 h1 s1 h2 s2 h2' s3 h3 s4 h3' s5 h4 s6 h4' h1' s8
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
196
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
197 h1 0:2 NNNNNNN:NNNNNNN
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
198 h2 0:1 *NNN:NNN*
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
199 h3 0:1 NNNNN:NNNNN
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
200 h4 0:1 NNNNN:NNNNN
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
201 s1 0 TN
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
202 s2 0 NNNN**********
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
203 s3 0 N
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
204 s4 0 NNNNNN*
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
205 s5 0 NN********************
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
206 s6 0 TTC****
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
207 s8 0 NCCA
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
208
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
209 Running RNABOB with ``trna.des`` against ``F22B7.fa`` searches the top strand of the cosmid for
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
210 the above motif. ``trna.des`` hits twice, once on each strand. (F22B7 has several other tRNA genes
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
211 in it which the pattern fails to detect - this is *not* a pattern to use for tRNA genefinding!).
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
212 ]]>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
213 </help>
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
214 <citations>
1
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
215 <citation type="doi">10.1093/bioinformatics/6.4.325</citation>
5a4b00c84f50 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/rna_tools/rnabob commit 1527e05bcd748a2b3cef22e0e356697066a55635
rnateam
parents: 0
diff changeset
216 <citation type="bibtex">@UNPUBLISHED{rnabob,
0
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
217 author = {Eddy S.R},
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
218 title = {RNABOB: a program to search for RNA secondary structure motifs in sequence databases},
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
219 note = {}}</citation>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
220 </citations>
cd00b4fe6552 Imported from capsule None
rnateam
parents:
diff changeset
221 </tool>