colrev.constants.RecordState¶
- class RecordState(value)[source]¶
Bases:
Enum
The possible RecordStates stored in the colrev_status field (corresponding to the ProcessModel)
Methods
Get the states that require a file
Get the states that correspond to not-yet-processed
Get the states after state x (passed as a parameter)
Attributes
Record is retrieved and stored in the ./search directory
Record is imported into the RECORDS_FILE
Record requires manual preparation (colrev_masterdata_provenance provides hints)
Record is prepared (no missing or incomplete fields, inconsistencies checked)
Record has been checked for duplicate associations with any record in RecordState md_processed or later
Record was excluded in the prescreen (based on titles/abstracts)
Record was included in the prescreen (based on titles/abstracts)
Record marked for manual PDF retrieval
PDF imported and marked for preparation
PDF is not available
PDF marked for manual preparation
PDF prepared
Record excluded in screen (full-text)
Record included in screen (full-text)
Record synthesized
- classmethod get_non_processed_states()[source]¶
Get the states that correspond to not-yet-processed
- Return type:
list
- classmethod get_post_x_states(*, state)[source]¶
Get the states after state x (passed as a parameter)
- Return type:
Set
[RecordState
]
- classmethod get_states_requiring_file()[source]¶
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