colrev.ops.prescreen.Prescreen¶

class colrev.ops.prescreen.Prescreen(*, review_manager, notify_state_transition_operation=True)[source]¶

Prescreen records (based on metadata)

Methods

`check_precondition`	Check the operation precondition
`conclude`	Conclude the operation (stop Docker containers)
`create_prescreen_split`	Split the prescreen between researchers
`decorate`	Decorator for operations
`exclude_records`	Exclude records in the prescreen
`export_table`	Export a table with records to prescreen
`get_data`	Get the data for prescreen
`import_table`	Import a table with prescreened records
`include_all_in_prescreen`	rtype: `Any`
`include_records`	Include records in the prescreen
`main`	rtype: `Any`
`notify`	Notify the review_manager about the next operation
`prescreen`	Save the prescreen decision
`setup_custom_script`	Setup a custom prescreen script

Attributes

type

check_precondition()¶

Check the operation precondition

conclude()¶

Conclude the operation (stop Docker containers)

create_prescreen_split(*, create_split)[source]¶

Split the prescreen between researchers

classmethod decorate()¶

Decorator for operations

exclude_records(*, ids)[source]¶

Exclude records in the prescreen

export_table(*, export_table_format='csv')[source]¶

Export a table with records to prescreen

Get the data for prescreen

import_table(*, import_table_path)[source]¶

Import a table with prescreened records

include_records(*, ids)[source]¶

Include records in the prescreen

notify(*, state_transition=True)¶

Notify the review_manager about the next operation

prescreen(*, record, prescreen_inclusion, PAD=40)[source]¶

Save the prescreen decision

setup_custom_script()[source]¶

Setup a custom prescreen script