forked from ropensci/roadoi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
78 lines (50 loc) · 2.7 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# roadoi - Use Unpaywall with R
```{r echo=FALSE}
knitr::opts_chunk$set(
comment = "#>",
collapse = TRUE,
warning = FALSE,
message = FALSE
)
```
[](https://travis-ci.org/ropensci/roadoi)
[](https://ci.appveyor.com/project/ropensci/roadoi)
[](https://codecov.io/github/ropensci/roadoi?branch=master)
[](https://cran.r-project.org/package=roadoi)
[](https://github.com/metacran/cranlogs.app)
[](https://github.com/ropensci/onboarding/issues/115)
roadoi interacts with the [Unpaywall API](http://unpaywall.org/products/api),
a simple web-interface which links DOIs and open access versions of scholarly works.
The API powers [Unpaywall](http://unpaywall.org/).
This client supports the most recent API Version 2.
API Documentation: <http://unpaywall.org/products/api>
## 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.
## 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)
```
## Long-Form Documentation including use-case
```{r child="vignettes/intro.Rmd"}
```
## 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.
[](https://ropensci.org)