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
|
\name{parse_Rdname}
\alias{parse_Rdname}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{
Parse the name section of an Rd object
}
\description{
Parse the name section of an Rd object.
}
\usage{
parse_Rdname(rdo)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
\item{rdo}{an Rd object}
}
\details{
The content of section "\verb{\name}" is extracted. If it contains a
hyphen, `-', the part before the hyphen is taken to be the topic
(usually a function name), while the part after the hyphen is the
type. If the name does not contain hyphens, the type is set to the
empty string. }
\value{
a list with two components:
\item{fname}{name of the topic, usually a function}
\item{type}{type of the topic, such as \verb{"method"}}
}
\author{Georgi N. Boshnakov}
%% ~Make other sections like Warning with \section{Warning }{....} ~
\examples{
u1 <- list_Rd(name = "Dummyname", alias = "Dummyallias1",
title = "Dummy title", description = "Dummy description",
Rd_class=TRUE )
parse_Rdname(u1)
u2 <- list_Rd(name = "dummyclass-class", alias = "Dummyclass",
title = "Class dummyclass",
description = "Objects and methods for something.",
Rd_class=TRUE )
parse_Rdname(u2)
}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\keyword{RdoProgramming}
|
