parse_Rdname: Parse the name section of an Rd object

Description Usage Arguments Details Value Author(s) Examples

View source: R/inspect.R

Description

Parse the name section of an Rd object.

Usage

1

Arguments

rdo

an Rd object

Details

The content of section "\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:

fname

name of the topic, usually a function

type

type of the topic, such as "method"

Author(s)

Georgi N. Boshnakov

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
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)

Rdpack documentation built on May 29, 2017, 12:36 p.m.

Search within the Rdpack package
Search all R packages, documentation and source code