The R Project SVN R

Rev

Rev 90191 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
82114 smeyer 1 
<!DOCTYPE html><html><head><title>R: An Rd Regression Test</title>
88796 smeyer 2 
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
3 
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
82114 smeyer 4 
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.15.3/dist/katex.min.css">
88796 smeyer 5 
<script>
88225 smeyer 6 
const macros = { "\\R": "\\textsf{R}", "\\mbox": "\\text", "\\code": "\\texttt"};
82114 smeyer 7 
function processMathHTML() {
8 
    var l = document.getElementsByClassName('reqn');
9 
    for (let e of l) { katex.render(e.textContent, e, { throwOnError: false, macros }); }
10 
    return;
11 
}</script>
12 
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.15.3/dist/katex.min.js"
13 
    onload="processMathHTML();"></script>
88796 smeyer 14 
<link rel="stylesheet" type="text/css" href="R.css">
85583 smeyer 15 
</head><body><div class="container"><main>
82114 smeyer 16 
 
82308 smeyer 17 
<table style="width: 100%;"><tr><td>testit</td><td style="text-align: right;">R Documentation</td></tr></table>
82114 smeyer 18 
 
85583 smeyer 19 
<h2>An Rd Regression Test</h2>
82114 smeyer 20 
 
21 
<h3>Usage</h3>
22 
 
23 
<pre><code class='language-R'>\x \y %{}
24 
 
84866 smeyer 25 
foo(<var>x</var>, <var>y</var>, ...)
82114 smeyer 26 
</code></pre>
27 
 
28 
 
84866 smeyer 29 
<h3>Arguments</h3>
30 
 
87564 smeyer 31 
<table role = "presentation">
85583 smeyer 32 
<tr><td><code id="x">x</code>, <code id="y">y</code></td>
84866 smeyer 33 
<td>
34 
 
35 
<p>combined arguments, in multiple Rd lines
36 
</p>
37 
<p>paragraph
38 
</p>
39 
</td></tr>
85583 smeyer 40 
<tr><td><code id="...">...</code></td>
84866 smeyer 41 
<td>
42 
<p>description of ...: ...</p>
43 
</td></tr>
44 
</table>
45 
 
46 
 
82114 smeyer 47 
<h3>Details</h3>
48 
 
86378 smeyer 49 
<p>Included
50 
 
51 
conditional content.
88476 smeyer 52 
End(<code style="white-space: pre;">&#8288;#ifdef&#8288;</code>).
86378 smeyer 53 
</p>
90191 smeyer 54 
 
82114 smeyer 55 
<p>Escaped backslash <code>\x</code>.
56 
</p>
57 
<p><code>%{}</code>
58 
</p>
82223 smeyer 59 
<p>a link and some to known destinations:
87442 smeyer 60 
<code>weighted.mean</code>, dito,
61 
<code>{</code>, <span class="env">R_HOME</span>.
82114 smeyer 62 
</p>
63 
<p>var in <var>text</var>.
64 
</p>
65 
<p><code>foo(<var>x</var>, <var>y</var>)</code>.
66 
</p>
84641 smeyer 67 
<p>Preformatted:</p>
82114 smeyer 68 
<pre>
69 
  Escaped backslash \x.
70 
 
71 
  %{}
72 
 
73 
  var in \var{text}.
74 
 
75 
  foo(\var{x}, \var{y}).
76 
 
77 
  From gap: pedtodot.Rd -- n=split(m,par,"\034")
78 
  </pre>
83788 smeyer 79 
 
80 
 
81 
<h3>Value</h3>
82 
 
88796 smeyer 83 
<p>[NULL]<br><br>...
83788 smeyer 84 
</p>
85 
 
86 
 
87 
<h3><code style="white-space: pre;">&#8288;\Sexpr&#8288;</code></h3>
88 
 
82114 smeyer 89 
<p>Yihui Xie's example:
90 
</p>
91 
<dl>
92 
<dt>def</dt><dd><p>ghi</p>
93 
</dd></dl>
94 
 
83788 smeyer 95 
<p>&ndash;
96 
<code style="white-space: pre;">&#8288;
97 
&gt; cat("\noutput\n")
83789 smeyer 98 
output
99 
&#8288;</code>
83788 smeyer 100 
&ndash;
82865 smeyer 101 
</p>
85195 smeyer 102 
<p><code style="white-space: pre;">&#8288;
85196 smeyer 103 
&gt; x&lt;-007
85195 smeyer 104 
&#8288;</code>
105 
</p>
88474 smeyer 106 
<p>Georgi Boshnakov's example of generated paragraphs:
107 
a
108 
</p>
88476 smeyer 109 
<p>b
110 
</p>
111 
<p>c
112 
</p>
89881 smeyer 113 
<p><em>one</em>
114 
two
89880 smeyer 115 
<em>one</em>
116 
two
117 
</p>
88492 smeyer 118 
<p><code style="white-space: pre;">&#8288;
88493 smeyer 119 
[1] "a\n    b\n    c"
88492 smeyer 120 
&#8288;</code>
121 
</p>
88559 smeyer 122 
<p>R (2025).
123 
&ldquo;<code class="reqn">t</code>.&rdquo;
124 
</p>
88474 smeyer 125 
 
126 
 
84641 smeyer 127 
<h3><code style="white-space: pre;">&#8288;\tabular&#8288;</code></h3>
128 
 
129 
 
130 
<table>
131 
<tr>
132 
 <td style="text-align: center;">
133 
    1 </td><td style="text-align: right;"> <a href="https://example.org/a&amp;b#c">linked text in <code style="white-space: pre;">&#8288;\tabular&#8288;</code></a>
134 
    </td><td style="text-align: left;"> <a href="https://example.org/a&amp;b#c">https://example.org/a&amp;b#c</a></td>
135 
</tr>
136 
<tr>
137 
 <td style="text-align: center;">
138 
    2 </td><td style="text-align: right;"> 2nd-column entry with <em>line break</em>
139 
    in Rd source</td><td style="text-align: left;"> third
140 
    column</td>
141 
</tr>
142 
<tr>
143 
 <td style="text-align: center;">
144 
    --3-- </td><td style="text-align: right;"> third
145 
    row</td><td style="text-align: left;">
146 
  </td>
147 
</tr>
148 
 
149 
</table>
150 
 
151 
 
152 
 
88433 smeyer 153 
<h3><code style="white-space: pre;">&#8288;\eqn&#8288;</code></h3>
154 
 
155 
<p>This should not start a new paragraph:
156 
<code class="reqn">\frac{1}{n-1}</code>.
157 
</p>
90030 smeyer 158 
<p>Simple 1-arg case with basic substitution in plain text (and legacy HTML):
159 
<code class="reqn">0 \le \code{x} \leq 1</code>
160 
</p>
90235 smeyer 161 
<p>More symbols: <code class="reqn">\sqrt{\sum_i (\log(x_i)-\mu)^2}</code> <br>
162 
where <code class="reqn">i \in \{1,\ldots,n\}</code> if <code class="reqn">n \times \pi &lt; \infty</code>.
163 
</p>
88433 smeyer 164 
 
165 
 
84641 smeyer 166 
<h3><code style="white-space: pre;">&#8288;\deqn&#8288;</code></h3>
167 
 
168 
<p>1-arg form, centered also in text conversion:
169 
</p>
170 
<p style="text-align: center;"><code class="reqn">
171 
    \theta = (\mu^*, \sigma^2, \rho)
172 
  </code>
173 
</p>
174 
 
175 
<p>2-arg form, where the text version is collapsed before centering
176 
(for the sake of existing Rd files):
177 
</p>
178 
<p style="text-align: center;"><code class="reqn">E = mc^2</code>
179 
</p>
180 
 
181 
<p>With AMS extension (R <code class="reqn">\ge</code> 4.2.2),
182 
where the text version spans more than 3 source lines (5 in fact)
183 
and is thus output as-is in R <code class="reqn">\ge</code> 4.4.0:
184 
</p>
185 
<p style="text-align: center;"><code class="reqn">
186 
    f(x) = \begin{cases}
187 
 
188 
      1 &amp; \text{if } x \ge 0.
189 
    \end{cases}
190 
  </code>
191 
</p>
192 
 
193 
 
194 
 
82114 smeyer 195 
<h3>Examples</h3>
196 
 
197 
<pre><code class='language-R'>\x
198 
%{}
86028 smeyer 199 
 
200 
## Not run: stop("doomed to fail")
201 
 
86378 smeyer 202 
foo(<var>x</var>,
203 
    <var>y</var>)
82114 smeyer 204 
</code></pre>
205 
 
85583 smeyer 206 
</main>
86376 smeyer 207 
 
82114 smeyer 208 
</div>
209 
</body></html>