parse_file {Rd2roxygen}R Documentation

Parse the input Rd file to a list

Description

This function uses the function parse_Rd in the tools package to parse the Rd file.

Usage

parse_file(path)

Arguments

path

the path of the Rd file

Value

a named list containing the documentation sections as strings

Author(s)

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

Examples

rd.file = system.file("examples", "parse_and_save.Rd", package = "Rd2roxygen")
parse_file(rd.file)

[Package Rd2roxygen version 1.4.2 Index]