Package interfaces

interface GeneralInterface[source]

The General Interface for all package endpoints

Each package endpoint must implement the following attributes (methods)

ci_supported

Flag indicating whether the package can be run in continuous integration environments (e.g. GitHub Actions)

interface ReviewTypeInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for ReviewTypes

initialize(settings)

Initialize the review type

interface SearchSourceInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for SearchSources

add_endpoint(operation, params)

Add the SearchSource as an endpoint based on a query (passed to colrev search -a) params: - search_file=”…” to add a DB search

heuristic(filename, data)

Heuristic to identify to which SearchSource a search file belongs (for DB searches)

heuristic_status

The status of the SearchSource heuristic

load(load_operation)

Load records from the SearchSource (and convert to .bib)

Retrieve masterdata from the SearchSource

prepare(record, source)

Run the custom source-prep operation

search(rerun)

Run a search of the SearchSource

search_types

SearchTypes associated with the SearchSource

settings_class

Class for the package settings

source_identifier

Source identifier for search and provenance Retrieved records are identified through the source_identifier when they are added to/updated in the SearchAPIFeed

interface PrepInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for prep operations

always_apply_changes

Flag indicating whether changes should always be applied (even if the colrev_status does not transition to md_prepared)

prepare(prep_record)

Run the prep operation

settings_class

Class for the package settings

source_correction_hint

Hint on how to correct metadata at source

interface PrepManInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for prep-man operations

prepare_manual(records)

Run the prep-man operation

settings_class

Class for the package settings

interface DedupeInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for dedupe operations

run_dedupe()

Run the dedupe operation

settings_class

Class for the package settings

interface PrescreenInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for prescreen operations

run_prescreen(records, split)

Run the prescreen operation

settings_class

Class for the package settings

interface PDFGetInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for pdf-get operations

get_pdf(record)

Run the pdf-get operation

settings_class

Class for the package settings

interface PDFGetManInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for pdf-get-man operations

pdf_get_man(records)

Run the pdf-get-man operation

settings_class

Class for the package settings

interface PDFPrepInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for pdf-prep operations

prep_pdf(record, pad)

Run the prep-pdf operation

settings_class

Class for the package settings

interface PDFPrepManInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for pdf-prep-man operations

pdf_prep_man(records)

Run the prep-man operation

settings_class

Class for the package settings

interface ScreenInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for screen operations

run_screen(records, split)

Run the screen operation

settings_class

Class for the package settings

interface DataInterface[source]

Extends: colrev.package_manager.interfaces.GeneralInterface

The PackageEndpoint interface for data operations

get_advice()

Get advice on how to operate the data package endpoint

settings_class

Class for the package settings

update_data(records, synthesized_record_status_matrix, silent_mode)

Update the data by running the data operation. This includes data extraction, analysis, and synthesis.

Parameters: records (dict): The records to be updated. synthesized_record_status_matrix (dict): The status matrix for the synthesized records. silent_mode (bool): Whether the operation is run in silent mode (for checks of review_manager/status).

update_record_status_matrix(synthesized_record_status_matrix, endpoint_identifier)

Update the record status matrix, i.e., indicate whether the record is rev_synthesized for the given endpoint_identifier