orcidtr (version 0.1.0)

orcid_person: Retrieve complete person data from ORCID

Description

Fetches comprehensive personal information including name, biography, keywords, researcher URLs, and other public profile data from an ORCID record.

Usage

orcid_person(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

given_names

Given (first) name

family_name

Family (last) name

credit_name

Published/credit name (if provided)

biography

Biography text

keywords

Comma-separated research keywords

researcher_urls

Comma-separated professional URLs

country

Country of residence

Returns a data.table with NA values for missing fields.

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. Optional API token for authenticated requests. If NULL (default), checks the ORCID_TOKEN environment variable. Most public data is accessible without authentication.

Details

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

This endpoint provides the most comprehensive biographical information in a single request, including name, biography, keywords, URLs, addresses, emails, and external identifiers.

References

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

See Also

orcid_bio, orcid_keywords, orcid_researcher_urls

Examples

if (FALSE) {
# Fetch complete person data
person <- orcid_person("0000-0002-1825-0097")
print(person)

# Access specific fields
person$biography
person$keywords

# With authentication
Sys.setenv(ORCID_TOKEN = "your-token-here")
person <- orcid_person("0000-0002-1825-0097")
}