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
|
_A_n _R_d _R_e_g_r_e_s_s_i_o_n _T_e_s_t
_U_s_a_g_e:
\x \y %{}
foo(x, y, ...)
_A_r_g_u_m_e_n_t_s:
x, y: combined arguments, in multiple Rd lines
paragraph
...: description of ...: ...
_D_e_t_a_i_l_s:
Included conditional content.
Escaped backslash '\x'.
'%{}'
a link and some to known destinations: 'weighted.mean', dito, '{',
'R_HOME'.
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")
_V_a_l_u_e:
[NULL]
...
\_S_e_x_p_r:
Yihui Xie's example:
def ghi
-
> cat("\noutput\n")
output
-
> x<-007
\_t_a_b_u_l_a_r:
1 linked text in \tabular <https://example.org/a&b#c>
2 2nd-column entry with _line break_ third
in Rd source column
-3- third
row
\_e_q_n:
This should not start a new paragraph: 1/(n-1).
\_d_e_q_n:
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 = m c^2
With AMS extension (R >= 4.2.2), where the text version spans more
than 3 source lines (5 in fact) and is thus output as-is in R >=
4.4.0:
0 if x < 0,
f(x) =
1 if x >= 0.
_E_x_a_m_p_l_e_s:
\x
%{}
## Not run: stop("doomed to fail")
foo(x,
y)
|