Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / mp_parse.tex
diff --git a/binaries/src/ViennaRNA/doc/latex/mp_parse.tex b/binaries/src/ViennaRNA/doc/latex/mp_parse.tex
new file mode 100644 (file)
index 0000000..0e1d9ba
--- /dev/null
@@ -0,0 +1,40 @@
+\subsection*{Representations of Secondary Structures}
+
+The standard representation of a secondary structure is the {\itshape bracket notation}, where matching brackets symbolize base pairs and unpaired bases are shown as dots. Alternatively, one may use two types of node labels, 'P' for paired and 'U' for unpaired; a dot is then replaced by '(U)', and each closed bracket is assigned an additional identifier 'P'. We call this the expanded notation. In\cite{fontana:1993b} a condensed representation of the secondary structure is proposed, the so-\/called homeomorphically irreducible tree (H\-I\-T) representation. Here a stack is represented as a single pair of matching brackets labeled 'P' and weighted by the number of base pairs. Correspondingly, a contiguous strain of unpaired bases is shown as one pair of matching brackets labeled 'U' and weighted by its length. Generally any string consisting of matching brackets and identifiers is equivalent to a plane tree with as many different types of nodes as there are identifiers.
+
+Bruce Shapiro proposed a coarse grained representation\cite{shapiro:1988}, which, does not retain the full information of the secondary structure. He represents the different structure elements by single matching brackets and labels them as 'H' (hairpin loop), 'I' (interior loop), 'B' (bulge), 'M' (multi-\/loop), and 'S' (stack). We extend his alphabet by an extra letter for external elements 'E'. Again these identifiers may be followed by a weight corresponding to the number of unpaired bases or base pairs in the structure element. All tree representations (except for the dot-\/bracket form) can be encapsulated into a virtual root (labeled 'R'), see the example below.
+
+The following example illustrates the different linear tree representations used by the package. All lines show the same secondary structure.
+
+\begin{DoxyVerb}a) .((((..(((...)))..((..)))).)).
+   (U)(((((U)(U)((((U)(U)(U)P)P)P)(U)(U)(((U)(U)P)P)P)P)(U)P)P)(U)
+b) (U)(((U2)((U3)P3)(U2)((U2)P2)P2)(U)P2)(U)
+c) (((H)(H)M)B)
+   ((((((H)S)((H)S)M)S)B)S)
+   (((((((H)S)((H)S)M)S)B)S)E)
+d) ((((((((H3)S3)((H2)S2)M4)S2)B1)S2)E2)R)
+\end{DoxyVerb}
+
+
+Above\-: \hyperlink{structTree}{Tree} representations of secondary structures. a) Full structure\-: the first line shows the more convenient condensed notation which is used by our programs; the second line shows the rather clumsy expanded notation for completeness, b) H\-I\-T structure, c) different versions of coarse grained structures\-: the second line is exactly Shapiro's representation, the first line is obtained by neglecting the stems. Since each loop is closed by a unique stem, these two lines are equivalent. The third line is an extension taking into account also the external digits. d) weighted coarse structure, this time including the virtual root.
+
+For the output of aligned structures from string editing, different representations are needed, where we put the label on both sides. The above examples for tree representations would then look like\-:
+
+\begin{DoxyVerb}a) (UU)(P(P(P(P(UU)(UU)(P(P(P(UU)(UU)(UU)P)P)P)(UU)(UU)(P(P(UU)(U...
+b) (UU)(P2(P2(U2U2)(P2(U3U3)P3)(U2U2)(P2(U2U2)P2)P2)(UU)P2)(UU)
+c) (B(M(HH)(HH)M)B)
+   (S(B(S(M(S(HH)S)(S(HH)S)M)S)B)S)
+   (E(S(B(S(M(S(HH)S)(S(HH)S)M)S)B)S)E)
+d) (R(E2(S2(B1(S2(M4(S3(H3)S3)((H2)S2)M4)S2)B1)S2)E2)R)
+\end{DoxyVerb}
+
+
+Aligned structures additionally contain the gap character '\-\_\-'.
+
+\subsection*{Parsing and Coarse Graining of Structures}
+
+Several functions are provided for parsing structures and converting to different representations.
+
+\begin{DoxyVerb}char  *expand_Full(const char *structure)
+\end{DoxyVerb}
+ Convert the full structure from bracket notation to the expanded notation including root. 
\ No newline at end of file