https://github.com/ropensci/roadoi

Use Unpaywall with R
https://github.com/ropensci/roadoi

altmetrics code4lib oadoi open-access peer-reviewed r r-package rstats unpaywall webclient

Last synced: about 1 month ago
JSON representation

Use Unpaywall with R

• Host: GitHub
• URL: https://github.com/ropensci/roadoi
• Owner: ropensci
• License: other
• Created: 2016-10-27T15:19:59.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2022-02-28T14:26:45.000Z (over 2 years ago)
• Last Synced: 2024-05-21T02:09:47.124Z (4 months ago)
• Topics: altmetrics, code4lib, oadoi, open-access, peer-reviewed, r, r-package, rstats, unpaywall, webclient
• Language: R
• Homepage: https://docs.ropensci.org/roadoi
• Size: 527 KB
• Stars: 64
• Watchers: 7
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - ropensci/roadoi - Use Unpaywall with R (R)

README

        
# roadoi - Use Unpaywall with R

```{r echo=FALSE}

knitr::opts_chunk$set(

  comment = "#>",

  collapse = TRUE,

  warning = FALSE,

  message = FALSE

)

```

[![R build status](https://github.com/ropensci/roadoi/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/roadoi/actions)

[![codecov.io](https://codecov.io/github/ropensci/roadoi/coverage.svg?branch=master)](https://codecov.io/github/ropensci/roadoi?branch=master)

[![cran version](http://www.r-pkg.org/badges/version/roadoi)](https://cran.r-project.org/package=roadoi)

[![rstudio mirror downloads](http://cranlogs.r-pkg.org/badges/roadoi)](https://github.com/r-hub/cranlogs.app)

[![review](https://badges.ropensci.org/115_status.svg)](https://github.com/ropensci/software-review/issues/115)

roadoi interacts with the [Unpaywall REST API](https://unpaywall.org/products/api), 

an openly available web-interface which returns metadata about open access versions of scholarly works. 

This client supports the most recent API Version 2.

API Documentation: 

## How do I use it? 

Use the `oadoi_fetch()` function in this package to get open access status

information and full-text links from Unpaywall.

```{r}

roadoi::oadoi_fetch(dois = c("10.1038/ng.3260", "10.1093/nar/gkr1047"), 

                    email = "[email protected]")

```

There are no API restrictions. However, providing an email address is required and a rate limit of 100k is suggested. If you need to access more data, use the [data dump](https://unpaywall.org/products/snapshot) instead.

### RStudio Addin

This package also has a RStudio Addin for easily finding free full-texts in RStudio.

![](man/figures/oadoi_addin.gif)

## How do I get it? 

Install and load from [CRAN](https://cran.r-project.org/package=roadoi):

```{r eval=FALSE}

install.packages("roadoi")

library(roadoi)

```

To install the development version, use the [devtools package](https://cran.r-project.org/package=devtools)

```{r eval = FALSE}

devtools::install_github("ropensci/roadoi")

library(roadoi)

```

## Documentation

See  to get started.

## Meta

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ropensci/roadoi/blob/master/CONDUCT.md). By participating in this project you agree to abide by its terms.

License: MIT

Please use the [issue tracker](https://github.com/ropensci/roadoi/issues) for bug reporting and feature requests.

[![ropensci_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)