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

desc_add_roleR Documentation

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 and orcid fields. If multiple filters are specified, then all must match to identify the author(s).

Usage

desc_add_role(
  role,
  given = NULL,
  family = NULL,
  email = NULL,
  comment = NULL,
  orcid = 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.

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_gh(), desc_add_author(), desc_add_me(), desc_add_orcid(), desc_change_maintainer(), desc_coerce_authors_at_r(), desc_del_author(), desc_del_role(), desc_get_authors(), desc_get_author(), desc_get_maintainer(), desc_set_authors()


desc documentation built on May 29, 2024, 8:54 a.m.