colrev.ops.screen.Screen

class colrev.ops.screen.Screen(*, review_manager, notify_state_transition_operation=True)[source]

Bases: Operation

Screen records (based on PDFs).

Initialize the instance.

Methods

`add_abstracts_from_tei`	Add abstracts from TEI files to records without abstracts.
`add_criterion`	Add a screening criterion to the records and settings.
`check_precondition`	Check the operation precondition.
`conclude`	Conclude the operation (stop Docker containers).
`create_screen_split`	Split the screen between researchers.
`decorate`	Decorator for operations.
`delete_criterion`	Delete a screening criterion from the records and settings.
`get_data`	Get the data (records to screen).
`get_screening_criteria`	Get the list of screening criteria from settings.
`include_all_in_screen`	Include all records in the screen.
`main`	rtype: `Any`
`notify`	Notify the review_manager about the next operation.
`screen`	Save the screen decision.
`set_screening_criteria`	Set the screening criteria in the settings.
`setup_custom_script`	Setup a custom screen script.
`to_screen`	This method checks if the record needs to be screened.

Attributes

type

add_abstracts_from_tei()[source]

Add abstracts from TEI files to records without abstracts.

Return type:: None

add_criterion(*, criterion_name, criterion)[source]

Add a screening criterion to the records and settings.

Return type:: None

check_precondition()

Check the operation precondition.

Return type:: None

conclude()

Conclude the operation (stop Docker containers).

Return type:: None

create_screen_split(*, create_split)[source]

Split the screen between researchers.

Return type:: list

classmethod decorate()

Decorator for operations.

Return type:: Callable

delete_criterion(criterion_to_delete)[source]

Delete a screening criterion from the records and settings.

Return type:: None

get_data()[source]

Get the data (records to screen).

Return type:: dict

get_screening_criteria()[source]

Get the list of screening criteria from settings.

Return type:: list

include_all_in_screen(*, persist)[source]

Include all records in the screen.

Return type:: None

notify(*, state_transition=True)

Notify the review_manager about the next operation.

Return type:: None

screen(*, record, screen_inclusion, screening_criteria, PAD=40)[source]

Save the screen decision.

Return type:: None

set_screening_criteria(screening_criteria)[source]

Set the screening criteria in the settings.

Return type:: None

setup_custom_script()[source]

Setup a custom screen script.

Return type:: None

to_screen(record_dict)[source]

This method checks if the record needs to be screened.

Return type:: bool