orcidtr (version 0.1.0)

orcid_address: Retrieve address information from ORCID

Description

Fetches address/country information associated with an ORCID record.

Usage

orcid_address(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

put_code

Unique identifier for this address

country

Country code

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

References

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

See Also

orcid_person

Examples

if (FALSE) {
# Fetch address information
address <- orcid_address("0000-0002-1825-0097")
print(address)
}