orcidtr (version 0.1.0)

orcid_educations: Retrieve education history from ORCID

Description

Fetches education records for a given ORCID identifier from the ORCID public API. Returns a structured data.table with education history including institutions, degrees, departments, and dates.

Usage

orcid_educations(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

put_code

Unique identifier for this education record

organization

Name of the educational institution

department

Department name (if available)

role

Degree or program name

start_date

Education start date (ISO format)

end_date

Education end date (ISO format)

city

City of institution

region

State/region of institution

country

Country of institution

Returns an empty data.table with the same structure if no education 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. Most public data is accessible without authentication.

Details

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

The function respects ORCID API rate limits and includes appropriate User-Agent headers identifying the orcidtr package.

References

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

See Also

orcid_employments, orcid_works, orcid_fetch_record

Examples

if (FALSE) {
# Fetch education history for a public ORCID
edu <- orcid_educations("0000-0002-1825-0097")
print(edu)

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