orcidtr (version 0.1.0)

orcid_email: Retrieve email information from ORCID

Description

Fetches email addresses associated with an ORCID record. Note that email addresses are typically private and require authentication to access.

Usage

orcid_email(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

email

Email address

primary

Logical indicating if this is the primary email

verified

Logical indicating if the email is verified

visibility

Visibility setting

Returns an empty data.table with the same structure if no emails are found or accessible.

Arguments

orcid_id

Character string. A valid ORCID identifier in the format XXXX-XXXX-XXXX-XXXX. Can also handle URLs like https://orcid.org/XXXX-XXXX-XXXX-XXXX.

token

Character string or NULL. API token for authenticated requests. If NULL (default), checks the ORCID_TOKEN environment variable. Email addresses usually require authentication.

Details

This function queries the ORCID public API endpoint: https://pub.orcid.org/v3.0/{orcid-id}/email

Email addresses are typically private and will only be returned if you have appropriate authentication permissions.

References

ORCID API Documentation: https://info.orcid.org/documentation/api-tutorials/

See Also

orcid_person

Examples

if (FALSE) {
# Fetch email (requires authentication)
Sys.setenv(ORCID_TOKEN = "your-token-here")
email <- orcid_email("0000-0002-1825-0097")
print(email)
}