create_roxygen {Rd2roxygen}R Documentation

Create the roxygen documentation

Description

The parsed information is converted to a vector of roxygen tags.

Usage

create_roxygen(info, usage = FALSE)

Arguments

info

the named list of the parsed documentation

usage

logical: whether to include the usage section in the output (this can be useful when there are multiple functions in a single usage section, but generally it is not necessary because roxygen can generate the usage section automatically)

Value

a character vector

Author(s)

Hadley Wickham; modified by Yihui Xie <http://yihui.name>

Examples

rd.file = system.file("examples", "parse_and_save.Rd", package = "Rd2roxygen")
options(roxygen.comment = "##' ")
create_roxygen(parse_file(rd.file))

[Package Rd2roxygen version 1.4.2 Index]