readDescription: Load description file

View source: R/buildPackage.R

readDescriptionR Documentation

Load description file

Description

Extract the description file of a package

Usage

readDescription(package, path, field = NULL, rm.blanck = TRUE, rm.comma = TRUE)

Arguments

package

the name of the package

path

the path to the directory containing the package

field

should a specific field of the description file be extracted

rm.blanck

should the initial blanck be removed?

rm.comma

should any comma be removed?

Examples

## Not run: 
readDescription <- butils:::readDescription
readDescription("butils", path = pathGitHub())
readDescription("butils", path = pathGitHub(), field = "Collate")
readDescription("butils", path = pathGitHub(), field = "Collate", rm.blanck = FALSE)

readDescription("butils", path = pathGitHub(), field = "Version")
readDescription("butils", path = pathGitHub(), field = "Imports")

readDescription("riskRegression", path = pathGitHub(), field = "Collate")
readDescription("lava.penalty", path = pathGitHub(), field = "Suggests")

## End(Not run)

bozenne/butils.base documentation built on May 13, 2024, 12:20 p.m.