-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from ropensci/cran_fix
Cran fix
- Loading branch information
Showing
11 changed files
with
122 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
Package: roadoi | ||
Type: Package | ||
Title: Find Free Versions of Scholarly Publications via Unpaywall | ||
Version: 0.7.2 | ||
Version: 0.7.3 | ||
Authors@R: c( | ||
person("Najko", "Jahn", role = c("aut", "cre"), email = "[email protected]"), | ||
person("Tuija", "Sonkkila", role = c("rev"), comment = c("Tuija Sonkkila | ||
reviewed the package for rOpenSci, | ||
see https://github.com/ropensci/onboarding/issues/115", ORCID = "0000-0002-6892-9305")), | ||
person("Ross Mounce", role = c("rev"), comment = c("Ross Mounce | ||
person("Ross", "Mounce", role = c("rev"), comment = c("Ross Mounce | ||
reviewed the package for rOpenSci, | ||
see https://github.com/ropensci/onboarding/issues/115", ORCID = "0000-0002-3520-2046")), | ||
person("Anne", "Hobert", role = c("ctb"), comment = c(ORCID = "0000-0003-2429-2995")), | ||
|
@@ -39,5 +39,7 @@ Suggests: | |
covr, | ||
rmarkdown, | ||
lintr | ||
RoxygenNote: 7.1.1 | ||
RoxygenNote: 7.3.2 | ||
VignetteBuilder: knitr | ||
Encoding: UTF-8 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,10 @@ | ||
## roadoi 0.7.3 | ||
|
||
Minor fixes: | ||
|
||
- Fix CRAN check issue | ||
- Update internal dependencies | ||
|
||
## roadoi 0.7 | ||
|
||
New features: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,62 @@ | ||
|
||
# roadoi - Use Unpaywall with R | ||
|
||
[![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) | ||
|
||
|
||
[![R build](https://github.com/ropensci/roadoi/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/roadoi/actions) | ||
[![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. | ||
|
||
|
||
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: <https://unpaywall.org/products/api> | ||
|
||
## How do I use it? | ||
## 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. | ||
|
||
|
||
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]") | ||
#> # A tibble: 2 x 21 | ||
#> doi best_oa_location oa_locations oa_locations_emb… | ||
#> <chr> <list> <list> <list> | ||
#> 1 10.1038… <tibble [1 × 11]> <tibble [1 … <tibble [0 × 0]> | ||
#> 2 10.1093… <tibble [1 × 10]> <tibble [6 … <tibble [0 × 0]> | ||
#> # … with 17 more variables: data_standard <int>, | ||
#> # is_oa <lgl>, is_paratext <lgl>, genre <chr>, | ||
#> # oa_status <chr>, has_repository_copy <lgl>, | ||
#> # journal_is_oa <lgl>, journal_is_in_doaj <lgl>, | ||
#> # journal_issns <chr>, journal_issn_l <chr>, | ||
#> # journal_name <chr>, publisher <chr>, | ||
#> # published_date <chr>, year <chr>, title <chr>, | ||
#> # updated_resource <chr>, authors <list> | ||
#> # A tibble: 2 × 21 | ||
#> doi best_oa_location oa_locations oa_locations_embargoed data_standard is_oa | ||
#> <chr> <list> <list> <list> <int> <lgl> | ||
#> 1 10.1038/ng.3260 <tibble [0 × 0]> <tibble> <tibble [0 × 0]> 2 FALSE | ||
#> 2 10.1093/nar/gkr… <tibble> <tibble> <tibble [0 × 0]> 2 TRUE | ||
#> # ℹ 15 more variables: is_paratext <lgl>, genre <chr>, oa_status <chr>, | ||
#> # has_repository_copy <lgl>, journal_is_oa <lgl>, journal_is_in_doaj <lgl>, | ||
#> # journal_issns <chr>, journal_issn_l <chr>, journal_name <chr>, publisher <chr>, | ||
#> # published_date <chr>, year <chr>, title <chr>, updated_resource <chr>, authors <list> | ||
``` | ||
|
||
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. | ||
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. | ||
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? | ||
## How do I get it? | ||
|
||
Install and load from [CRAN](https://cran.r-project.org/package=roadoi): | ||
|
||
|
||
``` r | ||
install.packages("roadoi") | ||
library(roadoi) | ||
``` | ||
|
||
To install the development version, use the [devtools | ||
package](https://cran.r-project.org/package=devtools) | ||
To install the development version, use the [devtools package](https://cran.r-project.org/package=devtools) | ||
|
||
|
||
``` r | ||
devtools::install_github("ropensci/roadoi") | ||
|
@@ -77,14 +69,10 @@ See <https://docs.ropensci.org/roadoi/> 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. | ||
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. | ||
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) | ||
[![ropensci_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,7 +47,7 @@ test_that("oadoi_fetch returns", { | |
|
||
|
||
# some character matches | ||
expect_match(h$oa_status, "bronze") | ||
expect_match(h$oa_status, "closed") | ||
expect_match(h$journal_issn_l, "0001-8708") | ||
expect_match(a$published_date, "2016-08-09") | ||
|
||
|
@@ -91,7 +91,7 @@ test_that("oadoi_fetch removes all types of whitespace", { | |
skip_on_cran() | ||
dois <- c("10.1177/ 0042098012452322", | ||
"10.1038/ng.3260 ", | ||
" 10. 7717/peerj.2323 | ||
" 10. 7717/peerj.2323 | ||
") | ||
a <- expect_message( | ||
oadoi_fetch(dois, email = "[email protected]") | ||
|
Oops, something went wrong.