readDescription: Load description file

Description Usage Arguments Examples

View source: R/buildPackage.R

Description

Extract the description file of a package

Usage

1
2
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## 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 April 1, 2020, 6:13 p.m.