Construct authors — construct_authors • rworkflows

Helper function to construct an author list for a DESCRIPTION file. Returns a template when authors is not provided (default).

construct_authors(
  authors = NULL,
  template = c(utils::person(given = "yourGivenName", family = "yourFamilyName", role =
    c("cre"), email = "yourEmail@email.com", comment = c(ORCID = "yourOrcidId")))
)

Arguments

authors: A list of authors who contributed to your R package, each provided as objects of class person. By default, if an Authors field already exists in the DESCRIPTION file, the original values are kept. Otherwise, a template person list is created using the construct_authors.
template: Default value to return when authors=NULL.

Value

Named list in person format.

Examples

authors <- construct_authors()