medrxivr

Project Status: Active – The project has reached a stable, usable state and is being actively developed. rOpenSci Badge
R build status Travis build status Codecov test coverage

An increasingly important source of health-related bibliographic content are preprints - preliminary versions of research articles that have yet to undergo peer review. The two preprint repositories most relevant to health-related sciences are medRxiv and bioRxiv, both of which are operated by the Cold Spring Harbor Laboratory.

The goal of the medrxivr R package is two-fold. In the first instance, it provides programmatic access to the Cold Spring Harbour Laboratory (CSHL) API, allowing users to easily download medRxiv and bioRxiv preprint metadata (e.g. title, abstract, publication date, author list, etc) into R. The package also provides access to a maintained static snapshot of the medRxiv repository (see Data sources). Secondly, medrxivr provides functions to search the downloaded preprint records using regular expressions and Boolean logic, as well as helper functions that allow users to export their search results to a .BIB file for easy import to a reference manager and to download the full-text PDFs of preprints matching their search criteria.

Installation

You can install the development version of this package using:

devtools::install_github("mcguinlu/medrxivr")
library(medrxivr)

Data sources

medRxiv data

medrixvr provides two ways to access medRxiv data:

# Get a copy of the database from the live medRxiv API endpoint
preprint_data <- mx_api_content()  
# Get a copy of the database from the daily snapshot
preprint_data <- mx_snapshot()  

The relationship between the two methods for the medRxiv database is summarised in the figure below:

bioRxiv data

Only one data source exists for the bioRxiv repository:

# Get a copy of the database from the live bioRxiv API endpoint
preprint_data <- mx_api_content(server = "biorxiv")

Once you have created a local copy of either the medRxiv or bioRxiv preprint database, you can pass this object (preprint_data in the examples above) to mx_search() to search the preprint records using an advanced search strategy.


# Perform a simple search
results <- mx_search(data = preprint_data,
                     query ="dementia")

# Perform an advanced search
topic1  <- c("dementia","vascular","alzheimer's")  # Combined with Boolean OR
topic2  <- c("lipids","statins","cholesterol")     # Combined with Boolean OR
myquery <- list(topic1, topic2)                    # Combined with Boolean AND

results <- mx_search(data = preprint_data,
                     query = myquery)

Further functionality

Export records identified by your search to a .BIB file

Pass the results of your search above (the results object) to the mx_export() to export references for preprints matching your search results to a .BIB file so that they can be easily imported into a reference manager (e.g. Zotero, Mendeley).


mx_export(data = results,
          file = "mx_search_results.bib")

Pass the results of your search above (the results object) to the mx_download() function to download a copy of the PDF for each record found by your search.


mx_download(results,        # Object returned by mx_search(), above
            "pdf/",         # Directory to save PDFs to 
            create = TRUE)  # Create the directory if it doesn't exist

Accessing the raw API data

By default, the mx_api_*() functions clean the data returned by the API for use with other medrxivr functions.

To access the raw data returned by the API, the clean argument should set to FALSE:

mx_api_content(to_date = "2019-07-01", clean = TRUE)

See this article for more details.

Detailed guidance

Detailed guidance, including advice on how to design complex search strategies, is available on the medrxivr website.

Linked repositories

See here for the code used to take the daily snapshot and the code that powers the medrxivr web app.

Code of conduct

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

Disclaimer

This package and the data it accesses/returns are provided “as is”, with no guarantee of accuracy. Please be sure to check the accuracy of the data yourself (and do let me know if you find an issue so I can fix it for everyone!)