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