binaries/src/ViennaRNA/doc/latex/PS__dot_8h.tex

   1 \hypertarget{PS__dot_8h}{\section{/home/asherstnev/\-Projects/\-Java.projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/\-P\-S\-\_\-dot.h File Reference}
   2 \label{PS__dot_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/\-P\-S\-\_\-dot.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/\-P\-S\-\_\-dot.\-h}}
   3 }
   4
   5
   6 Various functions for plotting R\-N\-A secondary structures, dot-\/plots and other visualizations.
   7
   8
   9 Include dependency graph for P\-S\-\_\-dot.\-h\-:
  10 \nopagebreak
  11 \begin{figure}[H]
  12 \begin{center}
  13 \leavevmode
  14 \includegraphics[width=250pt]{PS__dot_8h__incl}
  15 \end{center}
  16 \end{figure}
  17 \subsection*{Functions}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 int \hyperlink{PS__dot_8h_a0873c7cc4cd7a11c9a2cea19dde7e9c9}{P\-S\-\_\-rna\-\_\-plot} (char $\ast$string, char $\ast$structure, char $\ast$file)
  21 \begin{DoxyCompactList}\small\item\em Produce a secondary structure graph in Post\-Script and write it to 'filename'. \end{DoxyCompactList}\item
  22 int \hyperlink{PS__dot_8h_a47856b2504b566588785597b6ebb8271}{P\-S\-\_\-rna\-\_\-plot\-\_\-a} (char $\ast$string, char $\ast$structure, char $\ast$file, char $\ast$pre, char $\ast$post)
  23 \begin{DoxyCompactList}\small\item\em Produce a secondary structure graph in Post\-Script including additional annotation macros and write it to 'filename'. \end{DoxyCompactList}\item
  24 int \hyperlink{PS__dot_8h_a70834bc8c0aad4fe6824ff76ccb8f329}{gml\-R\-N\-A} (char $\ast$string, char $\ast$structure, char $\ast$ssfile, char option)
  25 \begin{DoxyCompactList}\small\item\em Produce a secondary structure graph in Graph Meta Language (gml) and write it to a file. \end{DoxyCompactList}\item
  26 int \hyperlink{PS__dot_8h_add368528755f9a830727b680243541df}{ssv\-\_\-rna\-\_\-plot} (char $\ast$string, char $\ast$structure, char $\ast$ssfile)
  27 \begin{DoxyCompactList}\small\item\em Produce a secondary structure graph in S\-Struct\-View format. \end{DoxyCompactList}\item
  28 int \hyperlink{PS__dot_8h_ae7853539b5df98f294b4af434e979304}{svg\-\_\-rna\-\_\-plot} (char $\ast$string, char $\ast$structure, char $\ast$ssfile)
  29 \begin{DoxyCompactList}\small\item\em Produce a secondary structure plot in S\-V\-G format and write it to a file. \end{DoxyCompactList}\item
  30 int \hyperlink{PS__dot_8h_a2f6d5953e6a323df898896b8d6614483}{xrna\-\_\-plot} (char $\ast$string, char $\ast$structure, char $\ast$ssfile)
  31 \begin{DoxyCompactList}\small\item\em Produce a secondary structure plot for further editing in X\-R\-N\-A. \end{DoxyCompactList}\item
  32 int \hyperlink{PS__dot_8h_a00ea223b5cf02eb2faae5ff29f0d5e12}{P\-S\-\_\-dot\-\_\-plot\-\_\-list} (char $\ast$seq, char $\ast$filename, \hyperlink{structplist}{plist} $\ast$pl, \hyperlink{structplist}{plist} $\ast$mf, char $\ast$comment)
  33 \begin{DoxyCompactList}\small\item\em Produce a postscript dot-\/plot from two pair lists. \end{DoxyCompactList}\item
  34 int \hyperlink{PS__dot_8h_aab48d4dac655d688abe921389ac2847c}{ali\-P\-S\-\_\-color\-\_\-aln} (const char $\ast$structure, const char $\ast$filename, const char $\ast$seqs\mbox{[}$\,$\mbox{]}, const char $\ast$names\mbox{[}$\,$\mbox{]})
  35 \item
  36 int \hyperlink{PS__dot_8h_a689a97a7e3b8a2df14728b8204d9d57b}{P\-S\-\_\-dot\-\_\-plot} (char $\ast$string, char $\ast$file)
  37 \begin{DoxyCompactList}\small\item\em Produce postscript dot-\/plot. \end{DoxyCompactList}\end{DoxyCompactItemize}
  38
  39
  40 \subsection{Detailed Description}
  41 Various functions for plotting R\-N\-A secondary structures, dot-\/plots and other visualizations.
  42
  43 \subsection{Function Documentation}
  44 \hypertarget{PS__dot_8h_a0873c7cc4cd7a11c9a2cea19dde7e9c9}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!P\-S\-\_\-rna\-\_\-plot@{P\-S\-\_\-rna\-\_\-plot}}
  45 \index{P\-S\-\_\-rna\-\_\-plot@{P\-S\-\_\-rna\-\_\-plot}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
  46 \subsubsection[{P\-S\-\_\-rna\-\_\-plot}]{\setlength{\rightskip}{0pt plus 5cm}int P\-S\-\_\-rna\-\_\-plot (
  47 \begin{DoxyParamCaption}
  48 \item[{char $\ast$}]{string, }
  49 \item[{char $\ast$}]{structure, }
  50 \item[{char $\ast$}]{file}
  51 \end{DoxyParamCaption}
  52 )}}\label{PS__dot_8h_a0873c7cc4cd7a11c9a2cea19dde7e9c9}
  53
  54
  55 Produce a secondary structure graph in Post\-Script and write it to 'filename'.
  56
  57 Note that this function has changed from previous versions and now expects the structure to be plotted in dot-\/bracket notation as an argument. It does not make use of the global \hyperlink{fold__vars_8h_a0244a629b5ab4f58b77590c3dfd130dc}{base\-\_\-pair} array anymore.
  58
  59
  60 \begin{DoxyParams}{Parameters}
  61 {\em string} & The R\-N\-A sequence \\
  62 \hline
  63 {\em structure} & The secondary structure in dot-\/bracket notation \\
  64 \hline
  65 {\em file} & The filename of the postscript output \\
  66 \hline
  67 \end{DoxyParams}
  68 \begin{DoxyReturn}{Returns}
  69 1 on success, 0 otherwise
  70 \end{DoxyReturn}
  71 \hypertarget{PS__dot_8h_a47856b2504b566588785597b6ebb8271}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!P\-S\-\_\-rna\-\_\-plot\-\_\-a@{P\-S\-\_\-rna\-\_\-plot\-\_\-a}}
  72 \index{P\-S\-\_\-rna\-\_\-plot\-\_\-a@{P\-S\-\_\-rna\-\_\-plot\-\_\-a}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
  73 \subsubsection[{P\-S\-\_\-rna\-\_\-plot\-\_\-a}]{\setlength{\rightskip}{0pt plus 5cm}int P\-S\-\_\-rna\-\_\-plot\-\_\-a (
  74 \begin{DoxyParamCaption}
  75 \item[{char $\ast$}]{string, }
  76 \item[{char $\ast$}]{structure, }
  77 \item[{char $\ast$}]{file, }
  78 \item[{char $\ast$}]{pre, }
  79 \item[{char $\ast$}]{post}
  80 \end{DoxyParamCaption}
  81 )}}\label{PS__dot_8h_a47856b2504b566588785597b6ebb8271}
  82
  83
  84 Produce a secondary structure graph in Post\-Script including additional annotation macros and write it to 'filename'.
  85
  86 Same as \hyperlink{PS__dot_8h_a0873c7cc4cd7a11c9a2cea19dde7e9c9}{P\-S\-\_\-rna\-\_\-plot()} but adds extra Post\-Script macros for various annotations (see generated P\-S code). The 'pre' and 'post' variables contain Post\-Script code that is verbatim copied in the resulting P\-S file just before and after the structure plot. If both arguments ('pre' and 'post') are N\-U\-L\-L, no additional macros will be printed into the Post\-Script.
  87
  88
  89 \begin{DoxyParams}{Parameters}
  90 {\em string} & The R\-N\-A sequence \\
  91 \hline
  92 {\em structure} & The secondary structure in dot-\/bracket notation \\
  93 \hline
  94 {\em file} & The filename of the postscript output \\
  95 \hline
  96 {\em pre} & Post\-Script code to appear before the secondary structure plot \\
  97 \hline
  98 {\em post} & Post\-Script code to appear after the secondary structure plot \\
  99 \hline
 100 \end{DoxyParams}
 101 \begin{DoxyReturn}{Returns}
 102 1 on success, 0 otherwise
 103 \end{DoxyReturn}
 104 \hypertarget{PS__dot_8h_a70834bc8c0aad4fe6824ff76ccb8f329}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!gml\-R\-N\-A@{gml\-R\-N\-A}}
 105 \index{gml\-R\-N\-A@{gml\-R\-N\-A}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 106 \subsubsection[{gml\-R\-N\-A}]{\setlength{\rightskip}{0pt plus 5cm}int gml\-R\-N\-A (
 107 \begin{DoxyParamCaption}
 108 \item[{char $\ast$}]{string, }
 109 \item[{char $\ast$}]{structure, }
 110 \item[{char $\ast$}]{ssfile, }
 111 \item[{char}]{option}
 112 \end{DoxyParamCaption}
 113 )}}\label{PS__dot_8h_a70834bc8c0aad4fe6824ff76ccb8f329}
 114
 115
 116 Produce a secondary structure graph in Graph Meta Language (gml) and write it to a file.
 117
 118 If 'option' is an uppercase letter the R\-N\-A sequence is used to label nodes, if 'option' equals {\itshape 'X'} or {\itshape 'x'} the resulting file will coordinates for an initial layout of the graph.
 119
 120
 121 \begin{DoxyParams}{Parameters}
 122 {\em string} & The R\-N\-A sequence \\
 123 \hline
 124 {\em structure} & The secondary structure in dot-\/bracket notation \\
 125 \hline
 126 {\em ssfile} & The filename of the gml output \\
 127 \hline
 128 {\em option} & The option flag \\
 129 \hline
 130 \end{DoxyParams}
 131 \begin{DoxyReturn}{Returns}
 132 1 on success, 0 otherwise
 133 \end{DoxyReturn}
 134 \hypertarget{PS__dot_8h_add368528755f9a830727b680243541df}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!ssv\-\_\-rna\-\_\-plot@{ssv\-\_\-rna\-\_\-plot}}
 135 \index{ssv\-\_\-rna\-\_\-plot@{ssv\-\_\-rna\-\_\-plot}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 136 \subsubsection[{ssv\-\_\-rna\-\_\-plot}]{\setlength{\rightskip}{0pt plus 5cm}int ssv\-\_\-rna\-\_\-plot (
 137 \begin{DoxyParamCaption}
 138 \item[{char $\ast$}]{string, }
 139 \item[{char $\ast$}]{structure, }
 140 \item[{char $\ast$}]{ssfile}
 141 \end{DoxyParamCaption}
 142 )}}\label{PS__dot_8h_add368528755f9a830727b680243541df}
 143
 144
 145 Produce a secondary structure graph in S\-Struct\-View format.
 146
 147 Write coord file for S\-Struct\-View
 148
 149
 150 \begin{DoxyParams}{Parameters}
 151 {\em string} & The R\-N\-A sequence \\
 152 \hline
 153 {\em structure} & The secondary structure in dot-\/bracket notation \\
 154 \hline
 155 {\em ssfile} & The filename of the ssv output \\
 156 \hline
 157 \end{DoxyParams}
 158 \begin{DoxyReturn}{Returns}
 159 1 on success, 0 otherwise
 160 \end{DoxyReturn}
 161 \hypertarget{PS__dot_8h_ae7853539b5df98f294b4af434e979304}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!svg\-\_\-rna\-\_\-plot@{svg\-\_\-rna\-\_\-plot}}
 162 \index{svg\-\_\-rna\-\_\-plot@{svg\-\_\-rna\-\_\-plot}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 163 \subsubsection[{svg\-\_\-rna\-\_\-plot}]{\setlength{\rightskip}{0pt plus 5cm}int svg\-\_\-rna\-\_\-plot (
 164 \begin{DoxyParamCaption}
 165 \item[{char $\ast$}]{string, }
 166 \item[{char $\ast$}]{structure, }
 167 \item[{char $\ast$}]{ssfile}
 168 \end{DoxyParamCaption}
 169 )}}\label{PS__dot_8h_ae7853539b5df98f294b4af434e979304}
 170
 171
 172 Produce a secondary structure plot in S\-V\-G format and write it to a file.
 173
 174
 175 \begin{DoxyParams}{Parameters}
 176 {\em string} & The R\-N\-A sequence \\
 177 \hline
 178 {\em structure} & The secondary structure in dot-\/bracket notation \\
 179 \hline
 180 {\em ssfile} & The filename of the svg output \\
 181 \hline
 182 \end{DoxyParams}
 183 \begin{DoxyReturn}{Returns}
 184 1 on success, 0 otherwise
 185 \end{DoxyReturn}
 186 \hypertarget{PS__dot_8h_a2f6d5953e6a323df898896b8d6614483}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!xrna\-\_\-plot@{xrna\-\_\-plot}}
 187 \index{xrna\-\_\-plot@{xrna\-\_\-plot}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 188 \subsubsection[{xrna\-\_\-plot}]{\setlength{\rightskip}{0pt plus 5cm}int xrna\-\_\-plot (
 189 \begin{DoxyParamCaption}
 190 \item[{char $\ast$}]{string, }
 191 \item[{char $\ast$}]{structure, }
 192 \item[{char $\ast$}]{ssfile}
 193 \end{DoxyParamCaption}
 194 )}}\label{PS__dot_8h_a2f6d5953e6a323df898896b8d6614483}
 195
 196
 197 Produce a secondary structure plot for further editing in X\-R\-N\-A.
 198
 199
 200 \begin{DoxyParams}{Parameters}
 201 {\em string} & The R\-N\-A sequence \\
 202 \hline
 203 {\em structure} & The secondary structure in dot-\/bracket notation \\
 204 \hline
 205 {\em ssfile} & The filename of the xrna output \\
 206 \hline
 207 \end{DoxyParams}
 208 \begin{DoxyReturn}{Returns}
 209 1 on success, 0 otherwise
 210 \end{DoxyReturn}
 211 \hypertarget{PS__dot_8h_a00ea223b5cf02eb2faae5ff29f0d5e12}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!P\-S\-\_\-dot\-\_\-plot\-\_\-list@{P\-S\-\_\-dot\-\_\-plot\-\_\-list}}
 212 \index{P\-S\-\_\-dot\-\_\-plot\-\_\-list@{P\-S\-\_\-dot\-\_\-plot\-\_\-list}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 213 \subsubsection[{P\-S\-\_\-dot\-\_\-plot\-\_\-list}]{\setlength{\rightskip}{0pt plus 5cm}int P\-S\-\_\-dot\-\_\-plot\-\_\-list (
 214 \begin{DoxyParamCaption}
 215 \item[{char $\ast$}]{seq, }
 216 \item[{char $\ast$}]{filename, }
 217 \item[{{\bf plist} $\ast$}]{pl, }
 218 \item[{{\bf plist} $\ast$}]{mf, }
 219 \item[{char $\ast$}]{comment}
 220 \end{DoxyParamCaption}
 221 )}}\label{PS__dot_8h_a00ea223b5cf02eb2faae5ff29f0d5e12}
 222
 223
 224 Produce a postscript dot-\/plot from two pair lists.
 225
 226 This function reads two plist structures (e.\-g. base pair probabilities and a secondary structure) as produced by \hyperlink{group__pf__fold_ga03e15e831a31b1154855ab47edbdb019}{assign\-\_\-plist\-\_\-from\-\_\-pr()} and \hyperlink{fold_8h_adaa59b81664e2e36cb9932e891558fae}{assign\-\_\-plist\-\_\-from\-\_\-db()} and produces a postscript \char`\"{}dot plot\char`\"{} that is written to 'filename'.\par
 227  Using base pair probabilities in the first and mfe structure in the second plist, the resulting \char`\"{}dot plot\char`\"{} represents each base pairing probability by a square of corresponding area in a upper triangle matrix. The lower part of the matrix contains the minimum free energy structure.
 228
 229 \begin{DoxySeeAlso}{See Also}
 230 \hyperlink{group__pf__fold_ga03e15e831a31b1154855ab47edbdb019}{assign\-\_\-plist\-\_\-from\-\_\-pr()}, \hyperlink{fold_8h_adaa59b81664e2e36cb9932e891558fae}{assign\-\_\-plist\-\_\-from\-\_\-db()}
 231 \end{DoxySeeAlso}
 232
 233 \begin{DoxyParams}{Parameters}
 234 {\em seq} & The R\-N\-A sequence \\
 235 \hline
 236 {\em filename} & A filename for the postscript output \\
 237 \hline
 238 {\em pl} & The base pair probability pairlist \\
 239 \hline
 240 {\em mf} & The mfe secondary structure pairlist \\
 241 \hline
 242 {\em comment} & A comment \\
 243 \hline
 244 \end{DoxyParams}
 245 \begin{DoxyReturn}{Returns}
 246 1 if postscript was successfully written, 0 otherwise
 247 \end{DoxyReturn}
 248 \hypertarget{PS__dot_8h_aab48d4dac655d688abe921389ac2847c}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!ali\-P\-S\-\_\-color\-\_\-aln@{ali\-P\-S\-\_\-color\-\_\-aln}}
 249 \index{ali\-P\-S\-\_\-color\-\_\-aln@{ali\-P\-S\-\_\-color\-\_\-aln}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 250 \subsubsection[{ali\-P\-S\-\_\-color\-\_\-aln}]{\setlength{\rightskip}{0pt plus 5cm}int ali\-P\-S\-\_\-color\-\_\-aln (
 251 \begin{DoxyParamCaption}
 252 \item[{const char $\ast$}]{structure, }
 253 \item[{const char $\ast$}]{filename, }
 254 \item[{const char $\ast$}]{seqs\mbox{[}$\,$\mbox{]}, }
 255 \item[{const char $\ast$}]{names\mbox{[}$\,$\mbox{]}}
 256 \end{DoxyParamCaption}
 257 )}}\label{PS__dot_8h_aab48d4dac655d688abe921389ac2847c}
 258 P\-S\-\_\-color\-\_\-aln for duplexes \hypertarget{PS__dot_8h_a689a97a7e3b8a2df14728b8204d9d57b}{\index{P\-S\-\_\-dot.\-h@{P\-S\-\_\-dot.\-h}!P\-S\-\_\-dot\-\_\-plot@{P\-S\-\_\-dot\-\_\-plot}}
 259 \index{P\-S\-\_\-dot\-\_\-plot@{P\-S\-\_\-dot\-\_\-plot}!PS_dot.h@{P\-S\-\_\-dot.\-h}}
 260 \subsubsection[{P\-S\-\_\-dot\-\_\-plot}]{\setlength{\rightskip}{0pt plus 5cm}int P\-S\-\_\-dot\-\_\-plot (
 261 \begin{DoxyParamCaption}
 262 \item[{char $\ast$}]{string, }
 263 \item[{char $\ast$}]{file}
 264 \end{DoxyParamCaption}
 265 )}}\label{PS__dot_8h_a689a97a7e3b8a2df14728b8204d9d57b}
 266
 267
 268 Produce postscript dot-\/plot.
 269
 270 Wrapper to P\-S\-\_\-dot\-\_\-plot\-\_\-list
 271
 272 Reads base pair probabilities produced by \hyperlink{group__pf__fold_gadc3db3d98742427e7001a7fd36ef28c2}{pf\-\_\-fold()} from the global array \hyperlink{fold__vars_8h_a0f5757427fd5f2f79d6fca0081cd5a52}{pr} and the pair list \hyperlink{fold__vars_8h_a0244a629b5ab4f58b77590c3dfd130dc}{base\-\_\-pair} produced by \hyperlink{group__mfe__fold_gaadafcb0f140795ae62e5ca027e335a9b}{fold()} and produces a postscript \char`\"{}dot plot\char`\"{} that is written to 'filename'. The \char`\"{}dot plot\char`\"{} represents each base pairing probability by a square of corresponding area in a upper triangle matrix. The lower part of the matrix contains the minimum free energy \begin{DoxyNote}{Note}
 273 D\-O N\-O\-T U\-S\-E T\-H\-I\-S F\-U\-N\-C\-T\-I\-O\-N A\-N\-Y\-M\-O\-R\-E S\-I\-N\-C\-E I\-T I\-S N\-O\-T T\-H\-R\-E\-A\-D\-S\-A\-F\-E
 274 \end{DoxyNote}
 275 \begin{DoxyRefDesc}{Deprecated}
 276 \item[\hyperlink{deprecated__deprecated000019}{Deprecated}]This function is deprecated and will be removed soon! Use \hyperlink{PS__dot_8h_a00ea223b5cf02eb2faae5ff29f0d5e12}{P\-S\-\_\-dot\-\_\-plot\-\_\-list()} instead! \end{DoxyRefDesc}