desc_get_field: Get a single field from a DESCRIPTION file, fail if not found

In r-lib/desc: Manipulate DESCRIPTION Files

Get a single field from a DESCRIPTION file, fail if not found

Description

desc_get_list() parses a comma separated list into a character vector.

Usage

desc_get_field(
  key,
  default = stop("Field '", key, "' not found"),
  trim_ws = TRUE,
  squish_ws = trim_ws,
  file = "."
)

desc_get_or_fail(keys, file = ".")

desc_get_list(
  key,
  default = stop("Field '", key, "' not found"),
  sep = ",",
  trim_ws = TRUE,
  squish_ws = trim_ws,
  file = "."
)

Arguments

key	The field to query.
default	Value to return if key is not found. By default it throws an error.
trim_ws	Whether to trim leading and trailing whitespace from the value. Defaults to TRUE.
squish_ws	Whether to reduce repeated whitespace in the value. Defaults to trim_ws.
file	DESCRIPTION file to use. By default the DESCRIPTION file of the current package (i.e. the package the working directory is part of) is used.
keys	Character vector of fields to get.
sep	Separator string for desc_get_list().

Value

Character string, the value of key, or default if key is not found and default is specified.

See Also

Other simple queries: desc_del(), desc_fields(), desc_get(), desc_has_fields(), desc_set()

r-lib/desc documentation built on Aug. 29, 2024, 5:23 p.m.