Skip to main content

Automated Systematic Review

Project description

ASReview bot

ASReview: Active learning for systematic reviews

Build StatusDocumentation Status DOI

This project is work in progress and not production ready.


Check out our new tutorial "10 minutes into ASReview"

Systematic Reviews are “top of the bill” in research. The number of systematic reviews published by researchers increases year after year. But performing a sound systematic review is a time-consuming and sometimes boring task. Our software is designed to accelerate the step of screening abstracts and titles with a minimum of papers to be read by a human with no or very few false negatives.

The Automated Systematic Review (ASReview) project implements learning algorithms that interactively query the researcher. This way of interactive training is known as Active Learning. ASReview offers support for classical learning algorithms and state-of-the-art learning algorithms like neural networks. The following image gives an overview of the process.

Active Learning for reviewing papers

Our ASReview software implements two different modes:

  • Oracle The oracle modus is used to perform a systematic review with interaction by the reviewer (the 'oracle' in literature on active learning). The software presents papers to the reviewer, whereafter the reviewer classifies them.
  • Simulate The simulation modus is used to measure the performance of our software on existing systematic reviews. The software shows how many papers you could have potentially skipped during the systematic review.

Installation

The ASReview software requires Python 3.6+. The project is available on Pypi. Install the project with:

pip install asreview

Or, install the development version of the Automated Systematic Review project directly from this Github page.

pip install git+https://github.com/asreview/asreview.git

Quick start

The quickest way to start using the Automated Systematic Review (ASR) software is the Command Line Interface (CLI). Start an interactive systematic review (Oracle mode) with the following line in CMD or shell:

asreview oracle YOUR_DATA.csv --log_file results.json

ASReview Command Line Interface

This command (asreview oracle) runs the software in oracle mode on the YOUR_DATA.csv dataset.

The higher the number of papers that you manually include in ASReview, the quicker the ASReview software will understand your choices for inclusion. The IDs are the identifiers of papers, starting from 0 for the first paper found in the dataset.

To benchmark an already executed review, use the simulation modus (asreview simulation). The dataset then needs an additional column ("label_included") to signify their inclusion in the final review. The command for the simulation modus is similar to the oracle mode:

asreview simulate YOUR_DATA.csv --n_prior_included 5 --n_prior_excluded 5 --log_file results.h5

Resources

Contributing

Got ideas for improvement? We would love to hear about your suggestions! Get started here

See who have contributed to ASReview here

Contact

This project is coordinated by by Rens van de Schoot (@Rensvandeschoot) and Daniel Oberski (@daob) and is part of the research work conducted by the Department of Methodology & Statistics, Faculty of Social and Behavioral Sciences, Utrecht University, The Netherlands. Maintainers are Jonathan de Bruin (Lead engineer, @J535D165) and Raoul Schram (@qubixes).

For any questions or remarks, please send an email to asreview@uu.nl.

License

LICENSE

Publications

Citation

A research paper is coming up for this project. In the mean time, it can be cited with (fill in x and y for the version number):

ASReview Core Development Team (2019). ASReview: Software for automated systematic reviews [version 0.x.y]. Utrecht University, Utrecht, The Netherlands. Available at https://github.com/asreview/asreview.

BibTeX:

@Manual{,
    title = {ASReview: Active learning for systematic reviews},
    author = {{ASReview Core Development Team}},
    organization = {Utrecht University},
    address = {Utrecht, The Netherlands},
    year = 2019,
    doi = {10.5281/zenodo.3345592},
    url = {https://doi.org/10.5281/zenodo.3345592}
}

Project details


Release history Release notifications | RSS feed

This version

0.7

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asreview-0.7.tar.gz (84.4 kB view details)

Uploaded Source

Built Distribution

asreview-0.7-py3-none-any.whl (114.8 kB view details)

Uploaded Python 3

File details

Details for the file asreview-0.7.tar.gz.

File metadata

  • Download URL: asreview-0.7.tar.gz
  • Upload date:
  • Size: 84.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7

File hashes

Hashes for asreview-0.7.tar.gz
Algorithm Hash digest
SHA256 0251f8ec9e061e33a124d68122fd7a639d1c53efcb811d2e702d9b17e89caa2f
MD5 464dcbbc1254090df557857d9edb6fef
BLAKE2b-256 5d071eac03163821eeec17f715376c763297d48e218ec8fdf491535ac44fbb9f

See more details on using hashes here.

File details

Details for the file asreview-0.7-py3-none-any.whl.

File metadata

  • Download URL: asreview-0.7-py3-none-any.whl
  • Upload date:
  • Size: 114.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.7

File hashes

Hashes for asreview-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1845f31ebd63c5cd08a47cf88c980dc7b65fdda4396b5f2b46a70df9f2def13f
MD5 5e86d6c6f5301ff081d33f53cf5dd2a2
BLAKE2b-256 719d979ac8cd8181e139de4e7c431158ef40f564db675c81ffded461cf1d5505

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page