desc_add_role: Add a role to one or more authors in Authors@R, in...

In r-lib/desc: Manipulate DESCRIPTION Files

Add a role to one or more authors in Authors@R, in DESCRIPTION

Description

The author(s) can be specified by a combination of the given, family, email, comment, orcid and ror fields. If multiple filters are specified, then all must match to identify the author(s). You cannot both specify orcid and ror since ORCID is for individuals, ROR for organizations.

Usage

desc_add_role(
  role,
  given = NULL,
  family = NULL,
  email = NULL,
  comment = NULL,
  orcid = NULL,
  ror = NULL,
  file = ".",
  normalize = FALSE
)

Arguments

role	Role to add.
given	Given name to filter on. Regular expression.
family	Family name to filter on. Regular expression.
email	Email address to filter on. Regular expression.
comment	Comment field to filter on. Regular expression.
orcid	ORCID field to filter on.
ror	ROR field to filter on.
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.
normalize	Whether to "normalize" (reorder and reformat) the fields when writing back the result. See desc_normalize().

See Also

Other Authors@R: desc_add_author(), desc_add_author_gh(), desc_add_me(), desc_add_orcid(), desc_add_ror(), desc_change_maintainer(), desc_coerce_authors_at_r(), desc_del_author(), desc_del_role(), desc_get_author(), desc_get_authors(), desc_get_maintainer(), desc_set_authors()

r-lib/desc documentation built on Feb. 10, 2025, 3:45 a.m.