ehrapy.plot.timeseries

ehrapy.plot.timeseries(edata, *, obs_names=None, var_names=None, tem_names=None, layer='tem_data', overlay=False, xlabel=None, ylabel=None, width=600, height=400, title=None)

Plot time series from a 3D EHRData object.

Selection logic: obs_names, var_names, tem_names select labels from edata.obs_names, edata.var_names, edata.tem.index. Use slice (e.g. slice(0, 5)) for positional selection along the axes.

Parameters:

• edata (EHRData) – Central data object.

• obs_names (str | int | Sequence[str | int] | None, default: None) – Unique observation identifier(s) to plot.

• var_names (str | Sequence[str] | None, default: None) – Variable name or list of variable names in edata.var_names to plot.

• tem_names (Any | Sequence[Any] | slice | None, default: None) – Time indices to plot.

• layer (str, default: 'tem_data') – layer to use for time series data.

• overlay (bool, default: False) – Whether to overlay multiple observations in a single plot (True) or create subplots (False).

• xlabel (str | None, default: None) – The x-axis label text.

• ylabel (str | None, default: None) – The y-axis label text.

• width (int | None, default: 600) – Plot width in pixels.

• height (int | None, default: 400) – Plot height in pixels.

• title (str | None, default: None) – Set the title of the plot.

Return type:

Overlay | Layout

Returns:

HoloViews Overlay (if overlay=True) or Layout (if overlay=False) object representing the time series plot(s).

Examples

>>> import ehrapy as ep
>>> import ehrdata as ed
>>> edata = ed.dt.ehrdata_blobs(n_variables=10, n_observations=5, base_timepoints=100)
>>> ep.pl.timeseries(edata, obs_names="1", var_names=["feature_1", "feature_2"], tem_names=slice(0, 10))