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
|
\name{predefined}
\alias{Rdo_predefined_sections}
\alias{Rdo_piece_types}
\alias{rdo_top_tags}
\title{
Tables of predefined sections and types of pieces of Rd objects
}
\description{
Tables of predefined sections and types of pieces of Rd objects.
}
\usage{
Rdo_predefined_sections
Rdo_piece_types
rdo_top_tags
}
\details{
The Rd syntax defines several tables
\insertCite{parseRd}{Rdpack}. \pkg{Rdpack} stores them in the
variables described here.
\code{Rdo_predefined_sections} is a named character vector providing
the types of the top level sections in an Rd object.
\code{Rdo_piece_types} is a named character vector giving the types of
the core (all possible?) Rd macros.
\strong{NOTE:} These objects are hard coded and need to be updated if
the specifications of the Rd format are updated.
todo: write functions that go through existing Rd documentation to
discover missing or wrong items.
}
\value{
for \code{Rdo_predefined_sections}, the name-value pairs are given in
the following table. For example, \code{Rdo_predefined_sections["examples"]} results
in \Sexpr[stage=build,results=rd]{Rdo_predefined_sections["examples"]}.
\Sexpr[stage=build,results=rd]{require(Rdpack);
paste(
"\\\\ifelse{latex}{\\\\out{",
"\\\\begin{tabular}{ll|lll}",
paste(names(Rdo_predefined_sections)[1:5], Rdo_predefined_sections[1:5],
" ",
names(Rdo_predefined_sections)[-(1:5)], Rdo_predefined_sections[-(1:5)],
sep=" & ", collapse="\\\\\\\\\\\\\\\\ \n"),
"\\\\end{tabular}",
"}}{",
"\\\\tabular{lllll}{",
paste(names(Rdo_predefined_sections)[1:5], Rdo_predefined_sections[1:5],
" | ",
names(Rdo_predefined_sections)[-(1:5)], Rdo_predefined_sections[-(1:5)],
sep=" \\\\tab ", collapse="\\\\cr\n"),
"}",
"}"
)}
for \code{Rdo_piece_types}, the name-value pairs are:
\Sexpr[stage=build,results=rd]{
paste(
"\\\\ifelse{latex}{\\\\out{",
"\\\\begin{tabular}{ll|ll|ll}",
paste(names(Rdo_piece_types), " & ", Rdo_piece_types, c(rep(" & ",2),"\\\\\\\\\\\\\\\\"),
sep="", collapse="\n"),
"\\\\end{tabular}",
"}}{",
"\\\\tabular{llllllllllll}{",
paste(names(Rdo_piece_types), "\\\\tab ", Rdo_piece_types,
c(rep(paste("\\\\tab ", "|", sep=""),2),
"\\\\cr"),
sep="", collapse="\n"),
"}",
"}"
)}
for \code{rdo_top_tags}, the values are:
\Sexpr[stage=build,results=rd]{
tmp_rdo_top_tags <- rdo_top_tags
tmp_incomplete <- length(tmp_rdo_top_tags) \%\% 5
if(tmp_incomplete != 0)
tmp_rdo_top_tags <- c(tmp_rdo_top_tags, rep("''", 5 - tmp_incomplete))
paste("\\\\tabular{lllll}{",
paste(sub("^[#]", "\\\\\\\\verb{#}", sub("^([\\\\])", "\\\\\\\\\\\\1", tmp_rdo_top_tags)),
c(rep("\\\\tab ",4),"\\\\cr"),
sep="", collapse="\n"),
"}")}
Note that most, but not all, are prefixed with a backslash.
}
\references{
\insertAllCited{}
}
\keyword{Rd}
|
