| testit | R Documentation |
An Rd Regression Test
Usage
\x \y %{}
foo(x, y, ...)
Arguments
x, y |
combined arguments, in multiple Rd lines paragraph |
... |
description of ...: ... |
Details
Included conditional content.
Escaped backslash \x.
%{}
a link and some to known destinations:
weighted.mean, {
var in text.
foo(x, y).
Preformatted:
Escaped backslash \x.
%{}
var in \var{text}.
foo(\var{x}, \var{y}).
From gap: pedtodot.Rd -- n=split(m,par,"\034")
Value
[NULL]
...
\Sexpr
Yihui Xie's example:
- def
ghi
–
> cat("\noutput\n")
output
–
> x<-007
\tabular
| 1 | linked text in \tabular
| https://example.org/a&b#c |
| 2 | 2nd-column entry with line break in Rd source | third column |
| --3-- | third row |
\deqn
1-arg form, centered also in text conversion:
\theta = (\mu^*, \sigma^2, \rho)
2-arg form, where the text version is collapsed before centering (for the sake of existing Rd files):
E = mc^2
With AMS extension (R \ge 4.2.2),
where the text version spans more than 3 source lines (5 in fact)
and is thus output as-is in R \ge 4.4.0:
f(x) = \begin{cases}
0 & \text{if } x < 0, \\
1 & \text{if } x \ge 0.
\end{cases}
Examples
\x
%{}
## Not run: stop("doomed to fail")
foo(x,
y)