Uses the Authors@R field.
Usage
desc_add_author_gh(
username,
role = "ctb",
comment = NULL,
orcid = NULL,
file = ".",
normalize = FALSE
)Arguments
- username
GitHub username of the GitHub user
- role
Role to set for the user, defaults to contributor.
- comment
Comment, empty by default.
- orcid
ORCID, empty by default.
- 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().
Details
desc_add_author_gh is a convenience function, it adds the
GitHub user as an author, and it needs the
gh package to be installed.
The full name is parsed using
as.person and collapsing the given name and the family name
in order to e.g. have the first and middle names together as given
name. This approach might be limited to some full name structures.
See also
Other Authors@R:
desc_add_author(),
desc_add_me(),
desc_add_orcid(),
desc_add_role(),
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()