Learn R Programming

orcidtr (version 0.1.0)

orcidtr-package: orcidtr: Retrieve Data from the ORCID Public API

Description

Provides functions to retrieve public data from ORCID (Open Researcher and Contributor ID) records via the ORCID public API. Fetches employment history, education, works (publications, datasets, preprints), funding, peer review activities, and other public information. Returns data as structured data.table objects for easy analysis and manipulation. Replaces the discontinued 'rorcid' package with a modern, CRAN-compliant implementation.

The orcidtr package provides a modern, CRAN-compliant interface to the ORCID public API. It allows you to retrieve employment history, education records, publications, funding information, and peer review activities from ORCID researcher profiles.

Arguments

Main Functions

  • orcid_employments(): Fetch employment history

  • orcid_educations(): Fetch education records

  • orcid_works(): Fetch publications and works

  • orcid_funding(): Fetch funding records

  • orcid_peer_reviews(): Fetch peer review activities

  • orcid_fetch_record(): Fetch complete ORCID record

  • orcid_fetch_many(): Batch fetch for multiple ORCIDs

Authentication

Most public data is accessible without authentication. To use an optional API token, set the ORCID_TOKEN environment variable:

Sys.setenv(ORCID_TOKEN = "your-token-here")

Package Design

  • Uses native pipe (|>) operator

  • Returns data.table objects

  • Fully qualified function calls (no library imports in functions)

  • No side effects or global state modifications

  • Graceful error handling

  • CRAN-compliant

Author

Maintainer: Lorenzo Fabbri lorenzo.fabbri92sm@gmail.com

References

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

See Also

Examples

Run this code
if (FALSE) {
# Fetch works for an ORCID
works <- orcid_works("0000-0002-1825-0097")

# Fetch complete record
record <- orcid_fetch_record("0000-0002-1825-0097")

# Batch fetch works for multiple ORCIDs
orcids <- c("0000-0002-1825-0097", "0000-0003-1419-2405")
all_works <- orcid_fetch_many(orcids, section = "works")
}

Run the code above in your browser using DataLab