orcidtr (version 0.1.0)

orcid_memberships: Retrieve memberships from ORCID

Description

Fetches professional membership records for an ORCID identifier, such as memberships in professional societies, organizations, etc.

Usage

orcid_memberships(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

put_code

Unique identifier for this membership record

organization

Name of the organization

department

Department name (if available)

role

Membership role or title

start_date

Membership start date (ISO format)

end_date

Membership end date (ISO format)

city

City of organization

region

State/region of organization

country

Country of organization

Returns an empty data.table with the same structure if no membership 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}/memberships

References

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

See Also

orcid_employments, orcid_activities

Examples

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