polite: Accessing the polite API pool

In subugoe/crlite: Lightweight R wrapper for the Crossref REST API

Description

Accessing the polite API pool

Usage

get_cr_mailto()

Related Functions and Methods

Functions

• get_cr_mailto: Get the email address to authenticate into the polite pool

  Whenever possible, API calls should be identified by an email address to reach the human responsible for making the call. In this order, returns the first valid email found in:

  1. The crlite.mailto option.

  2. The CR_MD_MAILTO environment variable (recommended only for secure environment variables in the cloud).

     On GitHub Actions, you can set the CR_MD_MAILTO environment variable to the email of the committer by retrieving the pusher email thus:

     env:
       CR_MD_MAILTO: ${{ github.event.pusher.email }}
     

  3. The git user email address for the repo at the working directory. This

  Otherwise, the function errors out.

See Also

Other api pool access functions: plus, pools()

subugoe/crlite documentation built on Sept. 19, 2021, 3:25 a.m.