This is the main function to retrieve comprehensive open access status information from Unpaywall data service. Please play nice with the API. For each user, 100k calls per day are suggested. If you need to access more data, there is also a data dump available. For more info see https://unpaywall.org/products/snapshot.
oadoi_fetch( dois = NULL, email = Sys.getenv("roadoi_email"), .progress = "none" )
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://unpaywall.org/dataset instead.
character vector, mandatory!
Unpaywall requires your email address,
so that they can track usage and notify you when something breaks.
Set email address in your `.Renviron` file with
The result is a tibble with each row representing a publication. Here are the returned columns and descriptions according to the API docu:
|DOI (always in lowercase).|
|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).|
|list-column of all the OA locations.|
|Indicates the data collection approaches used
for this resource. |
|Is there an OA copy (logical)?|
|Is the item an ancillary part of a journal, like a table of contents? See here for more information https://support.unpaywall.org/support/solutions/articles/44001894783.|
|Classifies OA resources by location and license terms as one of: gold, hybrid, bronze, green or closed. See here for more information https://support.unpaywall.org/support/solutions/articles/44001777288-what-do-the-types-of-oa-status-green-gold-hybrid-and-bronze-mean-.|
|Is a full-text available in a repository?|
|Is the article published in a fully OA journal?|
|Is the journal listed in the Directory of Open Access Journals (DOAJ).|
|ISSNs, i.e. unique numbers to identify journals.|
|Journal title, not normalized.|
|Publisher, not normalized.|
|Time when the data for this resource was last updated.|
|Lists author information (|
are list-columns that contain useful metadata about the OA sources
found by Unpaywall. The
best_oa_location only lists non-empty subfields.
|Unique repository identifier.|
|How the OA location was found and is characterized by Unpaywall?|
|OA full-text provided by |
|Is this location the |
|The license under which this copy is published, e.g. Creative Commons license.|
|OAI-PMH endpoint where we found this location.|
|Hosting institution of the repository.|
|Time when the data for this location was last updated.|
|The URL for a landing page describing this OA copy.|
|The URL with a PDF version of this OA copy.|
|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
Note that Unpaywall schema is only informally described. Check also https://unpaywall.org/data-format.