rromeo v0.1.1

0

Monthly downloads

0th

Percentile

Access Publisher Copyright & Self-Archiving Policies via the 'SHERPA/RoMEO' API

Fetches information from the 'SHERPA/RoMEO' API <http://www.sherpa.ac.uk/romeo/apimanual.php> which indexes policies of journal regarding the archival of scientific manuscripts before and/or after peer-review as well as formatted manuscripts.

Readme

rromeo – an R interface for SHERPA/RoMEO API

Project Status: Active – The project has reached a stable, usable
state and is being actively
developed. Travis build
status AppVeyor build
status codecov cran
checks CRAN-version

rromeo is an R client for the SHERPA/RoMEO API. SHERPA/RoMEO is a database that gives information on editorial policies of scientific journals regarding the archival of preprint, postprint and publishers’ manuscripts. rromeo is aimed at scientists interested in archival practices of scientific journals, such as professionals of scientometrics but also at scientist of specific fields interested in the practices of their fields.

Install

The latest stable release of rromeo is available on CRAN and can be installed with:

install.packages("rromeo")

You can also install the development version from GitHub:

# install.packages("remotes")
remotes::install_github("Rekyt/rromeo")

API Key

Note that SHERPA/RoMEO lets you run 500 requests per day per IP address, by registering for a free API key you can bypass this limit.

rromeo can use your registered SHERPA/RoMEO API key; you can either pass it as a string when querying the data with the argument key:

rr_journal_name("Journal of Geology", key = "Iq83AIL5bss")

or you can specify the environment variable SHERPAROMEO_KEY in an .Rprofile or in an .Renviron file and rromeo will automatically retrieve the API key.

Usage

rromeo contains functions to retrieve data from the SHERPA/RoMEO API (for a complete overview please refer to the vignette). The data is released under the Creative Commons Attribution-NonCommercial-ShareAlike 2.5 (CC BY-NC-SA 2.5) license. A suggestion of citation is included in rromeo via citation("rromeo").

rromeo functions are prefixed with rr_ such as rr_journal_name() that lets you retrieve a journal policy information using the title of a journal:

rromeo::rr_journal_name("Journal of Biogeography", qtype = "exact")
#>                     title provided_issn      issn romeocolour preprint
#> 1 Journal of Biogeography          <NA> 0305-0270      yellow      can
#>    postprint    pdf pre_embargo post_embargo pdf_embargo
#> 1 restricted cannot        <NA>    12 months        <NA>

the qtype argument indicates the type of query to make (exact for exact matching of the title, contains for partial matching and starts with to match only the beginning of the title).

You can also retrieve a journal information using its ISSN:

rromeo::rr_journal_issn("0305-0270")
#>                     title provided_issn      issn romeocolour preprint
#> 1 Journal of Biogeography     0305-0270 0305-0270      yellow      can
#>    postprint    pdf pre_embargo post_embargo pdf_embargo
#> 1 restricted cannot        <NA>    12 months        <NA>

rromeo also provides a function to retrieve information based on publisher ID rr_publisher().

SHERPA/RoMEO provides a synthetic “colour” for each journal, the colour summarizes the editorial policy of a journal:

RoMEO colour Archiving policy
green can archive preprint, postprint and publisher’s version
blue can archive postprint or publisher’s version
yellow can archive preprint
white archiving not formally supported

(Table taken from http://www.sherpa.ac.uk/romeo/definitions.php#colours)

rromeo lets you retrieve the policies of all journals of a given colour using the function rr_romeo_colour() (NOTE: this function can be slow as there are many journals to retrieve):

green_journals = rromeo::rr_romeo_colour("green")
green_journals[8:12,]
#>    romeoid                                                   publisher
#> 8     1128 Association for Information Science and Technology (ASIS&T)
#> 9     1937                                       University of Arizona
#> 10    2951                               Geological Society of America
#> 11    2521                              University of California Press
#> 12    2306                                  Optical Society of America
#>                  alias romeocolour preprint postprint        pdf
#> 8              JASIS&T       green      can       can     cannot
#> 9          Radiocarbon       green      can       can restricted
#> 10           GSA Today       green      can       can        can
#> 11            Collabra       green      can       can        can
#> 12 No Paid Open Access       green      can       can     cannot

Dependency network (Imports only)

Dependency network (Imports and Suggests)

Contributing to rromeo

We welcome contribution to rromeo! Please read the contribution guidelines if you want to contribute, as well as the below-mentioned Code of Conduct.

Code of Conduct

Please note that the rromeo project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

ropensci\_footer

Functions in rromeo

Name Description
parse_journal Parse API answer
rr_publisher_all Get all Publisher Policies
rr_journal_name Retrieve journals policies by matching title
rr_publisher_id Get Publisher Policy from Publisher ID
rr_publisher_name Get Publisher Policy by Publisher Name
rromeo-package rromeo: Access Publisher Copyright & Self-Archiving Policies via the 'SHERPA/RoMEO' API
rr_publisher_country Get Publisher Policy by Publisher's Country
rr_publisher_continent Get Publisher Policy by Publisher's Continent
validate_country_code Validate ISO two-letters country code
rr_romeo_colour Query publisher by RoMEO colour
rr_ua rromeo User Agent
validate_issn Checks validity of the ISSN
rr_auth Store provided API key into Environment Variable
parse_generic Generic parsing function
rr_journal_issn Retrieve journal policy using ISSN
parse_embargo Parse embargo period from API return
rr_api_version Return SHERPA/RoMEO API version
check_key Check SHERPA/RoMEO API key
rr_journal_find Find if journals are available in SHERPA/RoMEO
rr_GET rromeo internal GET function
parse_publisher Parse publisher list
No Results!

Vignettes of rromeo

Name
bar_graph-1.png
pie_chart-1.png
precompile.R
rromeo.Rmd
rromeo.Rmd.orig
setting_up_api_key.Rmd
setting_up_api_key.Rmd.orig
No Results!

Last month downloads

Details

Type Package
License GPL-3
Encoding UTF-8
LazyData true
RoxygenNote 7.0.2
Language en-US
VignetteBuilder knitr
URL https://docs.ropensci.org/rromeo/, https://github.com/ropensci/rromeo
BugReports https://github.com/ropensci/rromeo/issues
NeedsCompilation no
Packaged 2020-03-11 13:47:24 UTC; grenie
Repository CRAN
Date/Publication 2020-03-11 14:10:02 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/rromeo)](http://www.rdocumentation.org/packages/rromeo)