Development status¶

Currently, CoLRev is recommended for users with technical expertise. We use it for our own projects and the use of Git versioning prevents data losses. A detailed overview of the project status and the roadmap is provided below. The maturity is rated as follows:

Status	Description	Recommended for
	Functionality may not be fully implemented, tested, or documented.	Developers, not for general users.
	Functionality is implemented, partially tested, and documented.	Users with technical expertise.
	Functionality is fully implemented, including unit and user tests, as well as comprehensive documentation. Reviewed from a technical and methodological perspective.	Everyone.

The goal is to release new versions on a bi-monthly basis. The current focus is on the data management and integration with Git. Once CoLRev has matured, UIs should make it accessible to a broader user base. For details see the milestones on GitHub.

Core functionality ¶

Summary statement: The core functionality related to data management, operations, and environment services are fairly well documented and tested, although work is still in progress.

Collaboration ¶

Summary statement: The collaboration model relies on established git mechanisms. CoLRev partly supports the collaboration by applying formatting and consistency checks. More specific collaboration principles and guidelines are currently developed.

Packages ¶

Summary statement: The packages are generally under heavy development. Packages vary in maturity but most are not yet completed and require testing as well as documentation. At the same time, we use most packages regularly and quickly fix bugs.

The status of each package is provided in the operations subpages (init, search, load, prep, dedupe, prescreen, pdf-get, pdf-prep, screen, data). Instructions on adding new packages and having them reviewed are provided in the package development section.

Methods ¶

Summary statement: The operations are aligned with the established methodological steps of the review process and differences between review types and the typical forms of data analysis are considered during project setup. The encoding of review methodology is in progress and requires documentation.