systole.reports.frequency_table#

systole.reports.frequency_table(rr: List | ndarray | None = None, frequency_df: DataFrame | None = None, input_type: str = 'rr_ms', backend: str = 'tabulate', width: int | None = 600, height: int | None = 300) Column | str[source]#

Format frequency domain results for nice rendering.

Parameters:
rr

R-R interval time-series, peaks or peaks index vectors. The default expected vector is R-R intervals in milliseconds. Other data format can be provided by specifying the “input_type” (can be “rr_s”, “peaks” or “peaks_idx”).

frequency_df

The frequency domain results obtained from:py:func:systole.hrv.frequency_domain.

input_type

The type of input provided. Can be “peaks”, “peaks_idx”, “rr_ms” or “rr_s”. Defaults to “rr_ms”.

bakend

Which backend to use. Can be “bokeh” or “tabulate”. Defaults to “tabulate”.

width, height

The table width and height (only for “bokeh” backend).

Returns:
table

The formatted frequency domain table, either as a string or as a Bokeh Columns.