orcidtr (version 0.1.0)

orcid_activities: Retrieve activities summary from ORCID

Description

Fetches a comprehensive summary of all activities for an ORCID identifier in a single API call. This is more efficient than calling individual endpoints when you need multiple activity types.

Usage

orcid_activities(orcid_id, token = NULL)

Value

A named list with data.table elements for each activity section:

distinctions

Distinctions/awards summary

educations

Education history summary

employments

Employment history summary

invited_positions

Invited positions summary

memberships

Professional memberships summary

qualifications

Qualifications/licenses summary

services

Service activities summary

fundings

Funding records summary

peer_reviews

Peer review activities summary

research_resources

Research resources summary

works

Works/publications summary

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.

Details

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

This endpoint provides summary information for all activity types in a single request, which is more efficient than making multiple individual requests. However, the summaries contain less detail than the full individual records.

References

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

See Also

orcid_fetch_record, orcid_person

Examples

if (FALSE) {
# Fetch all activities
activities <- orcid_activities("0000-0002-1825-0097")
names(activities)

# Access specific sections
activities$works
activities$employments
activities$fundings
}