Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: olgagirona
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 204 MB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

[![DOI](https://zenodo.org/badge/363073613.svg)](https://zenodo.org/badge/latestdoi/363073613) [![PyPI - Version](https://img.shields.io/pypi/v/colrev?color=blue)](https://pypi.org/project/colrev/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/colrev) [![License](https://img.shields.io/github/license/CoLRev-Ecosystem/colrev.svg)](https://github.com/CoLRev-Environment/colrev/releases/) ![Documentation Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/docs_deploy.yml?label=documentation) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/CoLRev-Ecosystem/colrev/tests.yml?label=tests) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/CoLRev-Ecosystem/colrev/main.svg)](https://results.pre-commit.ci/latest/github/CoLRev-Ecosystem/colrev/main) ![Coverage](https://raw.githubusercontent.com/CoLRev-Ecosystem/colrev/main/tests/coverage.svg) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/bd4e44c6cda646e4b9e494c4c4d9487b)](https://app.codacy.com/gh/CoLRev-Environment/colrev/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) ![GitHub last commit](https://img.shields.io/github/last-commit/CoLRev-Ecosystem/colrev) [![Downloads](https://static.pepy.tech/badge/colrev/month)](https://pepy.tech/project/colrev) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7148/badge)](https://bestpractices.coreinfrastructure.org/projects/7148) [![SWH](https://archive.softwareheritage.org/badge/origin/https://github.com/CoLRev-Environment/colrev/)](https://archive.softwareheritage.org/browse/origin/?origin_url=https://github.com/CoLRev-Environment/colrev/) [![All Contributors](https://img.shields.io/badge/all_contributors-32-green.svg?style=flat-square)](#contributors)

Collaborative Literature Reviews (CoLRev)

CoLRev is an open-source environment for collaborative literature reviews. It integrates with differerent synthesis tools, takes care of the data, and facilitates Git-based collaboration.

To accomplish these goals, CoLRev advances the design of review technology at the intersection of methods, design, cognition, and community building. The following features stand out:

  • Supports all literature review steps: problem formulation, search, dedupe, (pre)screen, pdf retrieval and preparation, and synthesis
  • An open and extensible environment based on shared data and process standards
  • Builds on git and its transparent collaboration model for the entire literature review process
  • Offers a self-explanatory, fault-tolerant, and configurable user workflow
  • Operates a model for data quality, content curation, and reuse
  • Enables typological and methodological pluralism throughout the process

Demo

For details, consult the documentation.

Demo

You can try a live demonstration of CoLRev via GitHub codespaces: start demo.

Related work (preview)

The following shows a comparison of CoLRev with related tools.

[!Note] This is a preview. We plan to document and link the criteria, verify each cell, and invite the developers of the other tools to comment on the overview (documenting responses if the developers agree).

| Criteria | CoLRev | LitStudy | BUHOS | Covidence | |-----------------------------------------------|-----------------------------------|----------------------------------|---------------------------------|---------------------------------| | Review types | | | | | | Supports different genres of review methods | yes | no | no | no | | Extensibility | yes | maybe | maybe | no | | Process steps | | | | | | Review objectives and protocol | yes | yes | yes | yes | | Search | yes | yes | yes | yes | | Duplicate handling | yes | no | maybe | maybe | | (Pre)Screen | yes | maybe | yes | yes | | Data extraction | yes | maybe | yes | yes | | Data analysis and quality appraisal | yes | maybe | yes | yes | | Synthesis and reporting | yes | yes | yes | yes | | Process qualities | | | | | | Extensibility | yes | yes | no | no | | Extensions | 102 | 0 | 0 | 0 | | Search updates | yes | no | maybe | maybe | | Search: APIs | yes | yes | yes | no | | Metadata preparation | yes | yes | yes | maybe | | Retract checks | yes | no | no | yes | | PDF retrieval | yes | no | no | yes | | PDF preparation | yes | no | maybe | maybe | | Status tracking | yes | no | yes | yes | | Collaboration | | | | | | Large teams | yes | maybe | maybe | maybe | | Algorithms | yes | yes | maybe | maybe | | Data management | | | | | | Transparency | yes | no | no | no | | Validation | yes | no | no | no | | Reporting (e.g., PRISMA) | yes | no | yes | yes | | Publication of review | yes | yes | no | no | | Platform | | | | | | OSI-approved license | yes | yes | yes | no | | Peer-reviewed | no | yes | yes | no | | Technology | Python | Python | Ruby | Proprietary | | Setup | Local or cloud | Local or cloud | Server | Server | | Interface | CLI, Programmatic (GUI planned) | Jupyter Notebook | Web-UI | Web-UI | | Contributors | GitHub contributors | GitHub contributors | GitHub contributors | NA | | Commits | GitHub total commits | GitHub total commits | GitHub total commits | NA | | Last commit | GitHub last commit | GitHub last commit | GitHub last commit | NA | | Pull requests | GitHub Issues or Pull Requests | GitHub Issues or Pull Requests | GitHub Issues or Pull Requests | NA | | Forks | GitHub forks | GitHub forks | GitHub forks | NA | | Last release | GitHub last release | GitHub last release | GitHub last release | NA | | Current release | Releases | Releases | GitHub Release| NA |

Contributing, changes, and releases

Contributions, code and features are always welcome

For further information, see tests, changes, and releases.

Contributors

Gerit Wagner
Gerit Wagner

💻 📖 🔣 🖋 💡
Julian Prester
Julian Prester

💻 📖 🔣 🖋 🐛 🤔
Tarin Mahmood
Tarin Mahmood

💻 ⚠️ 📖
dengdenglele
dengdenglele

🔣 📖 ⚠️
mhlbrsimon
mhlbrsimon

💻
ossendorfluca
ossendorfluca

💻
katharinaernst
katharinaernst

💻
einfachjessi
einfachjessi

💻
Janus678
Janus678

💻
frxdericz
frxdericz

💻
MalouSchmidt
MalouSchmidt

💻
RheaDoesStuff
RheaDoesStuff

💻
Cohen2000
Cohen2000

💻
RobertAhr
RobertAhr

💻
ThomasFleischmann
ThomasFleischmann

💻
AntonFrisch
AntonFrisch

💻
LouisLangenhan
LouisLangenhan

💻 📖
Peter Eckhardt
Peter Eckhardt

💻 📖
User123projekt
User123projekt

💻 📖
LuminousLynx
LuminousLynx

💻 📖
koljarinne
koljarinne

💻
Karl Schnickmann
Karl Schnickmann

💻
edensarrival
edensarrival

💻
U1TIM4T3
U1TIM4T3

💻
Anna Geßler
annaglr

💻
0xmtyset
0xmtyset

💻
tobiaspffl
tobiaspffl

💻
CelinaSchwarz
CelinaSchwarz

💻
QuynhMaiNguyen
QuynhMaiNguyen

💻
pmao0907
pmao0907

💻
MingxinJiang
MingxinJiang

💻
JohannesDiel
JohannesDiel

💻

License

This project is distributed under the MIT License the documentation is distributed under the CC-0 license. If you contribute to the project, you agree to share your contribution following these licenses.

Citing CoLRev

Please cite the project as follows:

Wagner, G. and Prester, J. (2024) CoLRev - An open-source environment for Collaborative Literature Reviews. Available at https://github.com/CoLRev-Environment/colrev. doi:10.5281/zenodo.11668338

Owner

  • Login: olgagirona
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Wagner"
  given-names: "Gerit"
  orcid: "https://orcid.org/0000-0003-3926-7717"
- family-names: "Prester"
  given-names: "Julian"
  orcid: "https://orcid.org/0000-0003-2682-8036"
title: "CoLRev: An open-source environment for collaborative reviews"
version: 0.13.0
identifiers:
  - type: doi
    value: 10.5281/zenodo.13889524
date-released: 2024-10-04
url: "https://github.com/CoLRev-Environment/colrev"

GitHub Events

Total
  • Delete event: 1
  • Member event: 1
  • Public event: 1
  • Push event: 14
  • Pull request event: 2
  • Gollum event: 8
  • Create event: 11
Last Year
  • Delete event: 1
  • Member event: 1
  • Public event: 1
  • Push event: 14
  • Pull request event: 2
  • Gollum event: 8
  • Create event: 11

Dependencies

.github/workflows/docs_deploy.yml actions
  • actions/checkout v2 composite
  • actions/deploy-pages v1 composite
  • actions/setup-python v2 composite
  • actions/upload-pages-artifact v1 composite
.github/workflows/docs_make.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v2 composite
.github/workflows/poetry_update.yml actions
  • actions/checkout v3 composite
  • repo-sync/pull-request v2 composite
.github/workflows/publish_pypi.yml actions
  • actions/checkout v3 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.devcontainer/Dockerfile docker
  • mcr.microsoft.com/vscode/devcontainers/python 3.12-bullseye build
colrev/packages/abi_inform_proquest/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/acm_digital_library/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/add_journal_ranking/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/ais_library/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/arxiv/pyproject.toml pypi
  • feedparser ^6.0.10
  • python >=3.8, <4
colrev/packages/bibliography_export/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/blank/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/colrev_cli_pdf_get_man/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/colrev_cli_pdf_prep_man/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/colrev_cli_prescreen/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/colrev_cli_screen/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/colrev_curation/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/colrev_project/pyproject.toml pypi
  • pandasql ^0.7.3
  • python >=3.8, <4
colrev/packages/conceptual_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/conditional_prescreen/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/critical_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/crossref/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/curated_masterdata/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/curation_full_outlet_dedupe/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/curation_missing_dedupe/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/dblp/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/dedupe/pyproject.toml pypi
  • python >=3.10, <4
colrev/packages/descriptive_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/doi_org/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/download_from_website/pyproject.toml pypi
  • beautifulsoup4 ^4.11.1
  • python >=3.8, <4
colrev/packages/ebsco_host/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/eric/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/europe_pmc/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/exclude_collections/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/exclude_complementary_materials/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/exclude_languages/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/exclude_non_latin_alphabets/pyproject.toml pypi
  • alphabet-detector ^0.0.7
  • python >=3.8, <4
colrev/packages/export_man_prep/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/files_dir/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/general_polish/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/get_doi_from_urls/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/get_masterdata_from_citeas/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/get_masterdata_from_doi/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/get_year_from_vol_iss_jour/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/github/pyproject.toml pypi
  • PyGithub ^2.3.0
  • click ^8.1.6
  • python >=3.8, <4
colrev/packages/github_pages/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/google_scholar/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/grobid_tei/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/ieee/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/jstor/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/literature_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/local_index/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/meta_analysis/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/methodological_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/narrative_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/obsidian/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/ocrmypdf/poetry.lock pypi
colrev/packages/ocrmypdf/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/open_alex/pyproject.toml pypi
  • pyalex ^0.10
  • python >=3.8, <4
colrev/packages/open_citations_forward_search/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/open_library/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/osf/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/paper_md/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/pdf_backward_search/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/plos/pyproject.toml pypi
  • python >=3.9, <4
colrev/packages/prep_man_curation_jupyter/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/prescreen_table/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/prisma/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/profile/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/psycinfo/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/pubmed/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/qualitative_systematic_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/ref_check/pyproject.toml pypi
  • python >=3.9, <4
colrev/packages/remove_broken_ids/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/remove_coverpage/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/remove_last_page/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/remove_urls_with_500_errors/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/scientometric/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/scope_prescreen/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/scoping_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/scopus/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/screen_table/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/semanticscholar/pyproject.toml pypi
  • python >=3.8, <4
  • semanticscholar ^0.6.0
colrev/packages/source_specific_prep/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/springer_link/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/structured/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/sync/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/synergy_datasets/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/taylor_and_francis/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/theoretical_review/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/trid/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/ui_web/pyproject.toml pypi
  • dash ^2.11.1
  • python >=3.8, <4
colrev/packages/umbrella/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/unknown_source/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/unpaywall/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/web_of_science/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/website_screenshot/pyproject.toml pypi
  • python >=3.8, <4
colrev/packages/wiley/pyproject.toml pypi
  • python >=3.8, <4
poetry.lock pypi
  • 123 dependencies