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
|
\HeaderA{testit}{An Rd Regression Test}{testit}
\aliasB{\{}{testit}{.Rlbrace.}
%
\begin{Usage}
\begin{verbatim}
\x \y %{}
foo(x, y, ...)
\end{verbatim}
\end{Usage}
%
\begin{Arguments}
\begin{ldescription}
\item[\code{x}, \code{y}]
combined arguments, in multiple Rd lines
paragraph
\item[\code{...}] description of \dots: \ldots
\end{ldescription}
\end{Arguments}
%
\begin{Details}
Included
conditional content.
Escaped backslash \code{\bsl{}x}.
\code{\%\{\}}
\LinkA{a link}{a link} and some to known destinations:
\code{\LinkA{weighted.mean}{weighted.mean}}, \LinkA{dito}{dito},
\code{\LinkA{\{}{Paren}}, \LinkB{\env{R\_HOME}}{R.Rul.HOME}.
var in \var{text}.
\code{foo(\var{x}, \var{y})}.
Preformatted:\begin{alltt}
Escaped backslash \bsl{}x.
%\{\}
var in \bsl{}var\{text\}.
foo(\bsl{}var\{x\}, \bsl{}var\{y\}).
From gap: pedtodot.Rd -- n=split(m,par,"\bsl{}034")
\end{alltt}
\end{Details}
%
\begin{Value}
[NULL]\\{}\\{}\dots
\end{Value}
%
\begin{Section}{\AsIs{\texttt{\bsl{}Sexpr}}}
Yihui Xie's example:
\begin{description}
\item[def] ghi
\end{description}
--
\AsIs{\texttt{
> cat("\bsl{}noutput\bsl{}n")
output
}}
--
\AsIs{\texttt{
> x<-007
}}
\end{Section}
%
\begin{Section}{\AsIs{\texttt{\bsl{}tabular}}}
\Tabular{crl}{
1 & \Rhref{https://example.org/a\&b\#c}{linked text in \AsIs{\texttt{\bsl{}tabular}}}
& \url{https://example.org/a\&b\#c}\\{}
2 & 2nd-column entry with \emph{line break}
in Rd source& third
column\\{}
--3-- & third
row&
}
\end{Section}
%
\begin{Section}{\AsIs{\texttt{\bsl{}eqn}}}
This should not start a new paragraph:
\eqn{\frac{1}{n-1}}{}.
\end{Section}
%
\begin{Section}{\AsIs{\texttt{\bsl{}deqn}}}
1-arg form, centered also in text conversion:
\deqn{
\theta = (\mu^*, \sigma^2, \rho)
}{}
2-arg form, where the text version is collapsed before centering
(for the sake of existing Rd files):
\deqn{E = mc^2}{}
With AMS extension (R \eqn{\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 \eqn{\ge}{} 4.4.0:
\deqn{
f(x) = \begin{cases}
0 & \text{if } x < 0, \\
1 & \text{if } x \ge 0.
\end{cases}
}{}
\end{Section}
%
\begin{Examples}
\begin{ExampleCode}
\x
%{}
## Not run: stop("doomed to fail")
foo(x,
y)
\end{ExampleCode}
\end{Examples}
|
