feat: advanced validation options

[geritwagner]

Feature Request

Describe the Feature Request

The validation should be extended and provide the option to validate the type of review.

Describe Preferred Solution

The review types should be required by the endpoint interface to implement a new method (validate()).

The following validation options should be implemented:

Operations-specific (implemented as methods of the validation operation):

• search:inclusion-percentage (i.e., the number of papers that were prescreen-included relative to the number of all papers that were retrieved) should be in a particular range (e.g., 0.1 < inclusion-percentage < 0.5).
• pdf-get: percentage of papers for which PDFs are not-available should not exceed 0.1.

Review types (based on Templier and Paré 2018):

• Review types requiring multiple search techniques should include a citation search (a SearchSource with SearchType=BACKWARD_SEARCH|FORWARD_SEARCH)
• For review types focusing on emergent topics, the average age of papers in the sample should not be higher than 10 years.
• For review types requiring authors to minimize publication bias, the sample should contain unpublished ENTRYTYPE
• For review types requiring parallel independent prescreen or parallel independent data extraction, the git history should contain merge commits

The data required for the validation is available in the review_manager.settings, the records (review_manager.dataset.load_records_dict()), and the git history (via review_manager.dataset.get_repo()).

Expected Effort Required

2 months, 5 people.