package.contents {utils}R Documentation

Package Contents

Description

Parses and returns the ‘CONTENTS’ file of a package.

Usage

package.contents(pkg, lib.loc = NULL)

Arguments

pkg a character string with the package name.
lib.loc a character vector of directory names of R libraries, or NULL. The default value of NULL corresponds to all libraries currently known. If the default is used, the loaded packages are searched before the libraries.

Value

package.contents returns NA if there is no ‘CONTENTS’ file for the given package; otherwise, a character matrix with column names c("Entry", "Keywords", "Description") and rows giving the corresponding entries in the CONTENTS data base for each Rd file in the package.

See Also

read.dcf, package.description

Examples

package.contents("splines")
package.contents("splines")[, c("Entry", "Description")]

[Package Contents]