In dmi3kno/prereviewr: Access prereviews on PREreview.org

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

prereviewr

The goal of prereviewr is to use the official API to access (pre-)reviews from PREreview.org

PREreview's mission is to bring more equity and transparency to scholarly peer review by supporting and empowering communities of researchers, particularly those at early stages of their career (ECRs) and historically excluded, to review preprints in a process that is rewarding to them.

PREreview.org allows anyone to request a review for any published preprint and submit reviews for preprints contributed by other users. Because reviews are done prior to publication in an academic journal they are called "(pre-)reviews". Crowd-sourcing reviews prior to publication enables "constructive feedback to preprints at a point in time in which it is needed" (PREreview.org).

Installation

You can install the development version of prereviewr from Github with:

# install.packages("remotes")
remotes::install_github("dmi3kno/prereviewr")

The package subscribes to polite web-scraping principles and therefore the requests are made with authentication and an explicit user-agent, requests are delayed, responses are memoised. The permission to scrape is granted by official API. The package only accesses the endpoints allowed by the API and does not perform any scraping of webpages.

Authentication

Registration of API token on PREreview.org in free. If you are submitting preprints or reviews to the platform, you already have an account. Otherwise, go ahead and register. Then proceed to your API settings. There you can create a valid API key. Then you need to add the following two lines into your .Renviron using usethis::edit_r_environ()

PREREVIEW_APP=YOURAPPNAME
PREREVIEW_KEY=YOUR-KEY-FOUR-PARTS

Restart R and you should be good to go.

Example

This is a basic example which shows you how to solve a common problem:

library(prereviewr)
## basic example code

Preprints

You can fetch 10 latest preprints submitted to PREreview.org. The function returns a tibble with one row per preprint. There are some (so far unparsed) list columns which contain information about reviews

get_preprints()

It is also possible to search

get_preprints("perepolkin")

Individual preprint can be fetched with the following command. You can use the preprint DOI or PREreview UUID.

#get_preprint("ac0dc5be-4e85-424c-8659-d9c588b7dbc5")
get_preprint("10.31219/osf.io/enzgs")

Reviews

You can also fetch to latest (rapid) reviews

get_reviews()

Not all rapid reviews will be accompanied by a full review. The latest full reviews can be fetched with

get_reviews(full=TRUE)

If you are eagerly waiting for reviews for a preprint of interest you can check if any reviews have been recently submitted with

get_preprint_reviews("0043ad51-5bb9-4f67-9c70-617ca5e8efd9")

dmi3kno/prereviewr documentation built on Dec. 20, 2021, 12:10 a.m.