biopsykit.utils.legacy_helper module¶

Module providing helper functions to convert old BioPsyKit export files to new export formats.

biopsykit.utils.legacy_helper.legacy_convert_hr_phase_dict(file_path, export=True)[source]¶

Legacy conversion for HeartRatePhaseDict.

Legacy conversion includes changing the column name from “ECG_Rate” into “Heart_Rate”.

Parameters

file_path (Path or str) – path to file
export (bool, optional) – True to directly export the converted HeartRatePhaseDict under the same file name, False to return the converted HeartRatePhaseDict

Returns

The converted HeartRatePhaseDict, if export is False

Return type

HeartRatePhaseDict