colrev init
colrev init initializes a new CoLRev project. It requires an empty directory.
With this operation, the directories and files, including the git history, are set up.
It is recommended to select a review type using the --type parameter:
colrev init --type
Depending on the selected review type, the settings.json file is created with reasonable defaults. For example, a theoretical review may involve an emergent data analysis and synthesis approach, while a meta-analysis would involve a structured data extraction and a PRISMA flow chart for transparent reporting.
Once the CoLRev project is set up, it can be pushed to a Git server and shared with the team (see instructions).
The specific setup of the available review types is available in the following table:
Identifier |
Review type |
Status |
|---|---|---|
colrev.blank |
Blank Review (instructions) |
|
colrev.conceptual_review |
Conceptual review (instructions) |
|
colrev.critical_review |
Critical Review (instructions) |
|
colrev.curated_masterdata |
Curated masterdata (instructions) |
|
colrev.descriptive_review |
Descriptive Review (instructions) |
|
colrev.literature_review |
Literature Review (instructions) |
|
colrev.meta_analysis |
Meta-Analysis (instructions) |
|
colrev.methodological_review |
Methodological Review (instructions) |
|
colrev.narrative_review |
Narrative Review (instructions) |
|
colrev.qualitative_systematic_review |
Qualitative Systematic Review (instructions) |
|
colrev.scientometric |
Scientometric Review (instructions) |
|
colrev.scoping_review |
Scoping Review (instructions) |
|
colrev.theoretical_review |
Theoretical Review (instructions) |
|
colrev.umbrella |
Umbrella Review (instructions) |
