orcidtr (version 0.1.0)

orcid_peer_reviews: Retrieve peer review activities from ORCID

Description

Fetches peer review records for a given ORCID identifier from the ORCID public API. Returns a structured data.table with peer review activities including reviewer roles, review types, and organizations.

Usage

orcid_peer_reviews(orcid_id, token = NULL)

Value

A data.table with the following columns:

orcid

ORCID identifier

put_code

Unique identifier for this peer review record

reviewer_role

Role of the reviewer (e.g., reviewer, editor)

review_type

Type of review (e.g., review, evaluation)

review_completion_date

Date the review was completed (ISO format)

organization

Name of the convening organization (e.g., journal, conference)

Returns an empty data.table with the same structure if no peer review 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. Most public data is accessible without authentication.

Details

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

Peer review activities can include journal article reviews, conference paper reviews, grant reviews, and other forms of scholarly evaluation.

The function respects ORCID API rate limits and includes appropriate User-Agent headers identifying the orcidtr package.

References

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

See Also

orcid_works, orcid_funding, orcid_fetch_record

Examples

if (FALSE) {
# Fetch peer review records for a public ORCID
reviews <- orcid_peer_reviews("0000-0002-1825-0097")
print(reviews)

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