colrev.package_manager.package_base_classes.DataPackageBaseClass

class DataPackageBaseClass(*, data_operation, settings)[source]

Bases: ABC

The base class for Data packages.

Methods

get_advice

Get advice on how to operate the data package endpoint.

update_data

Update the data by running the data operation.

update_record_status_matrix

Update the record status matrix.

Attributes

ci_supported

settings_class

abstract get_advice()[source]

Get advice on how to operate the data package endpoint.

Return type:

dict

abstract update_data(records, synthesized_record_status_matrix, silent_mode)[source]

Update the data by running the data operation.

Return type:

None

abstract update_record_status_matrix(synthesized_record_status_matrix, endpoint_identifier)[source]

Update the record status matrix.

Return type:

None