rorcid-package: A programmatic R interface the Orcid.org API

In ropensci/rorcid: Interface to the 'Orcid.org' API

A programmatic R interface the Orcid.org API

Description

A R interface to the Orcid public API. rorcid is not a product developed or distributed by ORCID.

ORCID website: https://orcid.org/

Orcid API docs: http://members.orcid.org/api

Some key rorcid function:

• as.orcid() - coerce various inputs to ORCID class

• browse() - browse to a profile in your default browser

• check_dois() - check that strings are likely to be DOIs

• identifiers() - grab identifiers out of various objects

• orcid() and orcid_search() - Search for ORCID id's

• orcid_doi() - Search by DOI

• orcid_id() - Search by ORCID id, and get either bio, profile, or works

• works() - Parse out works from various objects

API routes not implemented

Not quite sure what these do so haven't messed with them.

• /{orcid}/notification-permission/{id}

• /client/{client_id}

• /group-id-record

• /group-id-record/{putCode}

Rate Limits

Definitions:

• Request a second - Number of request that can be made a second. Value: 8 per second (24 with API v2rc+) - Haven't been able to find up to date values for API v3 (so assume they are the same I guess)

• Burst - Number of request we will allow to be queued before rejecting. The request in the queue are slowed down at the request a second rate. Value: 40 (same with API v2rc+) - Haven't been able to find up to date values for API v3 (so assume they are the same I guess)

If you exceed the burst, you'll get a 503 responses. Developers should do their best to avoid approaching those limits.

Author(s)

Scott Chamberlain [e-mail]

See Also

rorcid-auth for Authentication information

ropensci/rorcid documentation built on Sept. 12, 2022, 2:09 p.m.