orcidtr (version 0.1.0)

orcid_distinctions: Retrieve distinctions from ORCID

Description

Fetches distinction records (awards, honors, recognitions) for an ORCID identifier. Returns structured data similar to employments and educations.

Usage

orcid_distinctions(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

put_code

Unique identifier for this distinction record

organization

Name of the awarding organization

department

Department name (if available)

role

Award or distinction title

start_date

Award/distinction date (ISO format)

end_date

End date (ISO format, if applicable)

city

City of organization

region

State/region of organization

country

Country of organization

Returns an empty data.table with the same structure if no distinction records are found.

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.

Details

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

References

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

See Also

orcid_employments, orcid_educations, orcid_activities

Examples

if (FALSE) {
# Fetch distinctions
distinctions <- orcid_distinctions("0000-0002-1825-0097")
print(distinctions)
}