roadoi (version 0.4)

oadoi_fetch: Fetch open access status information and full-text links from oaDOI

Description

This is the main function to retrieve comprehensive open access status information from the oaDOI service. Please play nice with the API. At the moment only 100k request are suggested per user and day. For more info see https://oadoi.org/api.

Usage

oadoi_fetch(dois = NULL, email = getOption("roadoi_email"),
  .progress = "none")

Arguments

dois

character vector, search by a single DOI or many DOIs. A rate limit of 100k requests per day is suggested. If you need to access more data, request the data dump https://oadoi.org/api instead.

email

character vector, mandatory! oaDOI requires your email address, so that they can track usage and notify you when something breaks. Set email address in your `.Rprofile` file with the option `roadoi_email` options(roadoi_email = "[e-mail]").

.progress

Shows the plyr-style progress bar. Options are "none", "text", "tk", "win", and "time". See create_progress_bar for details of each. By default, no progress bar is displayed.

Value

The result is a tibble with each row representing a publication. Here are the returned columns and descriptions according to the API docu:

doi	DOI (always in lowercase).
best_oa_location	list-column describing the best OA location. Algorithm prioritizes publisher hosted content (eg Hybrid or Gold), then prioritizes versions closer to the version of record (PublishedVersion over AcceptedVersion), then more authoritative repositories (PubMed Central over CiteSeerX).
oa_locations	list-column of all the OA locations.
data_standard	Indicates the data collection approaches used for this resource. 1 mostly uses Crossref for hybrid detection. 2 uses more comprehensive hybrid detection methods.
is_oa	Is there an OA copy (logical)?
journal_is_oa	Is the article published in a fully OA journal? Uses the Directory of Open Access Journals (DOAJ) as source.
journal_issns	ISSNs, i.e. unique numbers to identify journals.
journal_name	Journal title, not normalized.
publisher	Publisher, not normalized.
title	Publication title.
year	Year published.
updated	Time when the data for this resource was last updated.
non_compliant	Lists other full-text resources that are not hosted by either publishers or repositories.

The columns best_oa_location and oa_locations are list-columns that contain useful metadata about the OA sources found by oaDOI. These are

evidence	How the OA location was found and is characterized by oaDOI?
host_type	OA full-text provided by publisher or repository.
license	The license under which this copy is published, e.g. Creative Commons license.
url	The URL where you can find this OA copy.
versions	The content version accessible at this location following the DRIVER 2.0 Guidelines (https://wiki.surfnet.nl/display/DRIVERguidelines/DRIVER-VERSION+Mappings

To unnest list-columns, you want to use tidyr's unnest function unnest.

Examples

# NOT RUN {
oadoi_fetch("10.1038/nature12373", email = "[e-mail]")
oadoi_fetch(dois = c("10.1016/j.jbiotec.2010.07.030",
"10.1186/1471-2164-11-245", email = "[e-mail]"))
# }
# NOT RUN {
# }