colrev.constants.RecordState

class RecordState(value)

Bases: Enum

The possible RecordStates stored in the colrev_status field (corresponding to the ProcessModel)

Methods

get_states_requiring_file	Get the states that require a file
get_non_processed_states	Get the states that correspond to not-yet-processed
get_post_x_states	Get the states after state x (passed as a parameter)

Attributes

md_retrieved	Record is retrieved and stored in the ./search directory
md_imported	Record is imported into the RECORDS_FILE
md_needs_manual_preparation	Record requires manual preparation (colrev_masterdata_provenance provides hints)
md_prepared	Record is prepared (no missing or incomplete fields, inconsistencies checked)
md_processed	Record has been checked for duplicate associations with any record in RecordState md_processed or later
rev_prescreen_excluded	Record was excluded in the prescreen (based on titles/abstracts)
rev_prescreen_included	Record was included in the prescreen (based on titles/abstracts)
pdf_needs_manual_retrieval	Record marked for manual PDF retrieval
pdf_imported	PDF imported and marked for preparation
pdf_not_available	PDF is not available
pdf_needs_manual_preparation	PDF marked for manual preparation
pdf_prepared	PDF prepared
rev_excluded	Record excluded in screen (full-text)
rev_included	Record included in screen (full-text)
rev_synthesized	Record synthesized

classmethod get_non_processed_states()

Get the states that correspond to not-yet-processed

Return type:

list

classmethod get_post_x_states(*, state)

Get the states after state x (passed as a parameter)

Return type:

Set[RecordState]

classmethod get_states_requiring_file()

Get the states that require a file

Return type:

list

md_imported = 2

Record is imported into the RECORDS_FILE

md_needs_manual_preparation = 3

Record requires manual preparation (colrev_masterdata_provenance provides hints)

md_prepared = 4

Record is prepared (no missing or incomplete fields, inconsistencies checked)

md_processed = 5

Record has been checked for duplicate associations with any record in RecordState md_processed or later

md_retrieved = 1

Record is retrieved and stored in the ./search directory

pdf_imported = 9

PDF imported and marked for preparation

pdf_needs_manual_preparation = 11

PDF marked for manual preparation

pdf_needs_manual_retrieval = 8

Record marked for manual PDF retrieval

pdf_not_available = 10

PDF is not available

pdf_prepared = 12

PDF prepared

rev_excluded = 13

Record excluded in screen (full-text)

rev_included = 14

Record included in screen (full-text)

rev_prescreen_excluded = 6

Record was excluded in the prescreen (based on titles/abstracts)

rev_prescreen_included = 7

Record was included in the prescreen (based on titles/abstracts)

rev_synthesized = 15

Record synthesized