Get or Set the ResearchBox API Key — rbox

ResearchBox's API (https://researchbox.org/api_call.php) needs a personal key, which you can make at https://researchbox.org/api. metacheck reads it from the RESEARCHBOX_API_KEY environment variable, which you can set in your .Renviron file (usethis::edit_r_environ()):

Usage

rbox_token(token = NULL)

Arguments

token: the key to set, or NULL to get the current key

Value

the current key (character; "" when none is set)

Details

RESEARCHBOX_API_KEY="your-key"

Setting the key with rbox_token() overrides that for the current session only. Without a key, rbox_info() and rbox_file_download() read the box's web page instead, and rbox_files() and rbox_search() are not available.

aspredicted_info() and the prereg_check module also use the key: ResearchBox's API serves AsPredicted's public preregistrations. Without a key, the preregistrations are read from AsPredicted's web pages, and AsPredicted asks for a captcha after several pages, after which no more are read.

Examples

rbox_token() # returns "" unless a key is set
#> [1] ""