resolve_panel

resolve_panel(
    df,
    entity=None,
    time=None,
    *,
    require_entity=False,
    require_time=False,
)

Resolve the (entity, time) ids for df: explicit args win, else df.attrs.

Parameters

Name Type Description Default
df pd.DataFrame The panel data frame. required
entity str | None Explicit identifiers. When None, fall back to the values stored by :func:set_panel (if any). None
time str | None Explicit identifiers. When None, fall back to the values stored by :func:set_panel (if any). None
require_entity bool When True, raise :class:ValueError if the corresponding id cannot be resolved. False
require_time bool When True, raise :class:ValueError if the corresponding id cannot be resolved. False

Returns

Name Type Description
tuple of (str or None, str or None) The resolved (entity, time) column names.

Raises

Name Type Description
ValueError If a resolved column is not present in df, or a required id is unresolved.