orcidtr (version 0.1.0)

orcid_fetch_record: Retrieve complete ORCID record

Description

Fetches all public data for a given ORCID identifier, including employments, education, works, funding, and peer reviews. Returns a named list of data.table objects.

Usage

orcid_fetch_record(
  orcid_id,
  token = NULL,
  sections = c("employments", "educations", "works", "funding", "peer-reviews")
)

Value

A named list with the following possible elements (each a data.table):

employments

Employment history

educations

Education history

distinctions

Distinctions and honors

invited_positions

Invited positions

memberships

Professional memberships

qualifications

Qualifications

services

Service activities

research_resources

Research resources

works

Works/publications

funding

Funding records

peer_reviews

Peer review activities

person

Complete person data

bio

Biography

keywords

Keywords

researcher_urls

Researcher URLs

external_identifiers

External identifiers

other_names

Other names

address

Address information

email

Email addresses

Empty data.tables are returned for sections with no data.

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.

sections

Character vector. Sections to fetch. Default is the most commonly used sections: c("employments", "educations", "works", "funding", "peer-reviews"). Available sections are:

• Affiliations: "employments", "educations", "distinctions", "invited-positions", "memberships", "qualifications", "services", "research-resources"

• Activities: "works", "funding", "peer-reviews"

• Biographical: "person", "bio", "keywords", "researcher-urls", "external-identifiers", "other-names", "address", "email"

You can specify a subset to fetch only specific sections.

Details

This is a convenience function that calls individual API functions for each section. Each section requires a separate API request.

To minimize API calls, specify only the sections you need using the sections parameter.

References

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

See Also

orcid_fetch_many, orcid_employments, orcid_works

Examples

if (FALSE) {
# Fetch complete record for a public ORCID
record <- orcid_fetch_record("0000-0002-1825-0097")
names(record)
record$works
record$employments

# Fetch only works and funding
record <- orcid_fetch_record(
  "0000-0002-1825-0097",
  sections = c("works", "funding")
)

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