The R Project SVN R

Rev

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

Rev Author Line No. Line
82223 smeyer 1 
\HeaderA{testit}{An Rd Regression Test}{testit}
2 
\aliasB{\{}{testit}{.Rlbrace.}
3 
%
4 
\begin{Usage}
5 
\begin{verbatim}
6 
\x \y %{}
7 
 
84866 smeyer 8 
foo(x, y, ...)
82223 smeyer 9 
\end{verbatim}
10 
\end{Usage}
11 
%
84866 smeyer 12 
\begin{Arguments}
13 
\begin{ldescription}
85169 smeyer 14 
\item[\code{x}, \code{y}]
84866 smeyer 15 
combined arguments, in multiple Rd lines
16 
 
17 
paragraph
18 
 
19 
\item[\code{...}] description of \dots: \ldots
20 
\end{ldescription}
21 
\end{Arguments}
22 
%
82865 smeyer 23 
\begin{Details}
86378 smeyer 24 
Included
25 
conditional content.
88475 smeyer 26 
End(\AsIs{\texttt{\#ifdef}}).
86378 smeyer 27 
 
82223 smeyer 28 
Escaped backslash \code{\bsl{}x}.
29 
 
30 
\code{\%\{\}}
31 
 
32 
\LinkA{a link}{a link} and some to known destinations:
87442 smeyer 33 
\code{\LinkA{weighted.mean}{weighted.mean}}, \LinkA{dito}{dito},
34 
\code{\LinkA{\{}{Paren}}, \LinkB{\env{R\_HOME}}{R.Rul.HOME}.
82223 smeyer 35 
 
36 
var in \var{text}.
37 
 
38 
\code{foo(\var{x}, \var{y})}.
84641 smeyer 39 
 
40 
Preformatted:\begin{alltt}
82223 smeyer 41 
  Escaped backslash \bsl{}x.
42 
 
43 
  %\{\}
44 
 
45 
  var in \bsl{}var\{text\}.
46 
 
47 
  foo(\bsl{}var\{x\}, \bsl{}var\{y\}).
48 
 
49 
  From gap: pedtodot.Rd -- n=split(m,par,"\bsl{}034")
50 
  \end{alltt}
51 
 
83788 smeyer 52 
\end{Details}
53 
%
54 
\begin{Value}
83865 smeyer 55 
[NULL]\\{}\\{}\dots
83788 smeyer 56 
\end{Value}
57 
%
58 
\begin{Section}{\AsIs{\texttt{\bsl{}Sexpr}}}
82223 smeyer 59 
Yihui Xie's example:
60 
\begin{description}
61 
\item[def] ghi
62 
\end{description}
63 
 
83788 smeyer 64 
 
65 
--
66 
\AsIs{\texttt{
67 
> cat("\bsl{}noutput\bsl{}n")
83789 smeyer 68 
output
69 
}}
83788 smeyer 70 
--
85195 smeyer 71 
 
72 
\AsIs{\texttt{
85196 smeyer 73 
> x<-007
85195 smeyer 74 
}}
88474 smeyer 75 
 
76 
Georgi Boshnakov's example of generated paragraphs:
77 
a
78 
 
79 
b
80 
 
81 
c
88492 smeyer 82 
 
89880 smeyer 83 
\emph{one}
84 
two
85 
\emph{one}
86 
two
87 
 
88492 smeyer 88 
\AsIs{\texttt{
88493 smeyer 89 
[1] "a\bsl{}n    b\bsl{}n    c"
88492 smeyer 90 
}}
88559 smeyer 91 
 
92 
R (2025).
93 
``\eqn{t}{}.''
83788 smeyer 94 
\end{Section}
82223 smeyer 95 
%
84641 smeyer 96 
\begin{Section}{\AsIs{\texttt{\bsl{}tabular}}}
97 
 
98 
\Tabular{crl}{
99 
1 & \Rhref{https://example.org/a\&b\#c}{linked text in \AsIs{\texttt{\bsl{}tabular}}}
100 
& \url{https://example.org/a\&b\#c}\\{}
101 
2 & 2nd-column entry with \emph{line break}
102 
in Rd source& third
103 
column\\{}
104 
--3-- & third
105 
row&
106 
}
107 
\end{Section}
108 
%
88433 smeyer 109 
\begin{Section}{\AsIs{\texttt{\bsl{}eqn}}}
110 
This should not start a new paragraph:
111 
\eqn{\frac{1}{n-1}}{}.
90030 smeyer 112 
 
113 
Simple 1-arg case with basic substitution in plain text (and legacy HTML):
114 
\eqn{0 \le \code{x} \leq 1}{}
90235 smeyer 115 
 
116 
More symbols: \eqn{\sqrt{\sum_i (\log(x_i)-\mu)^2}}{} \\{}
117 
where \eqn{i \in \{1,\ldots,n\}}{} if \eqn{n \times \pi < \infty}{}.
88433 smeyer 118 
\end{Section}
119 
%
84641 smeyer 120 
\begin{Section}{\AsIs{\texttt{\bsl{}deqn}}}
121 
1-arg form, centered also in text conversion:
122 
\deqn{
123 
    \theta = (\mu^*, \sigma^2, \rho)
124 
  }{}
125 
2-arg form, where the text version is collapsed before centering
126 
(for the sake of existing Rd files):
127 
\deqn{E = mc^2}{}
128 
 
129 
With AMS extension (R \eqn{\ge}{} 4.2.2),
130 
where the text version spans more than 3 source lines (5 in fact)
131 
and is thus output as-is in R \eqn{\ge}{} 4.4.0:
132 
\deqn{
133 
    f(x) = \begin{cases}
134 
 
135 
      1 & \text{if } x \ge 0.
136 
    \end{cases}
137 
  }{}
138 
\end{Section}
139 
%
82223 smeyer 140 
\begin{Examples}
141 
\begin{ExampleCode}
142 
\x
143 
%{}
86028 smeyer 144 
 
145 
## Not run: stop("doomed to fail")
146 
 
86378 smeyer 147 
foo(x,
148 
    y)
82223 smeyer 149 
\end{ExampleCode}
150 
\end{Examples}