desc {desc} | R Documentation |
Read a DESCRIPTION file
Description
This is a convenience wrapper for description$new()
.
Very often you want to read an existing DESCRIPTION
file, and to do this you can just supply the path to the file or its
directory to desc()
.
Usage
desc(cmd = NULL, file = NULL, text = NULL, package = NULL)
Arguments
cmd |
A command to create a description from scratch.
Currently only |
file |
Name of the |
text |
A character scalar containing the full DESCRIPTION. Character vectors are collapsed into a character scalar, with newline as the separator. |
package |
If not NULL, then the name of an installed package and the DESCRIPTION file of this package will be loaded. |
Examples
desc(package = "desc")
DESCRIPTION <- system.file("DESCRIPTION", package = "desc")
desc(DESCRIPTION)