eml_party: Create an EML party

In NCEAS/arcticdatautils: Utilities for the Arctic Data Center

Create an EML party

Description

\Sexpr[results=rd, stage=render]{lifecycle::badge("deprecated")}

Usage

eml_party(
  type = "associatedParty",
  given_names = NULL,
  sur_name = NULL,
  organization = NULL,
  position = NULL,
  email = NULL,
  phone = NULL,
  address = NULL,
  userId = NULL,
  role = NULL
)

Arguments

type	(character) The type of party (e.g. 'contact').
given_names	(character) The party's given name(s).
sur_name	(character) The party's surname.
organization	(character) The party's organization name.
position	(character) The party's position.
email	(character) The party's email address(es).
phone	(character) The party's phone number(s).
address	(character) The party's address(es) as a valid EML address
userId	(character) The party's ORCID, in format https://orcid.org/WWWW-XXXX-YYYY-ZZZZ.
role	(character) The party's role.

Details

Please use the constructors in the EML package instead

You will usually want to use the high-level functions such as eml_creator() and eml_contact() but using this is fine.

The userId argument assumes an ORCID so be sure to adjust for that.

Value

(party) An instance of the party specified by the type argument.

Examples

## Not run: 
eml_party("creator", "Test", "User")
eml_party("creator", "Bryce", "Mecum", userId = "https://orcid.org/0000-0002-0381-3766")
eml_party("creator", given_names = list("Dominic", "'Dom'"),
                     sur_name = "Mullen", list("NCEAS", "UCSB"),
                     position = list("Data Scientist", "Programmer"),
                         address = eml$address(deliveryPoint = "735 State St",
                         city = "Santa Barbara",
                         administrativeArea = "CA",
                         postalCode = "85719"))

## End(Not run)

NCEAS/arcticdatautils documentation built on Aug. 28, 2023, 12:10 p.m.