Skip to content

panel_aware_suffix

yohou.utils.panel.panel_aware_suffix(col, suffix)

Add a suffix to a column name while preserving the panel group prefix.

For panel data columns (<GROUP>__<SERIES>), the suffix is appended to the series part: <GROUP>__<SERIES>_<SUFFIX>.

For global columns, the suffix is appended: <COLUMN>_<SUFFIX>.

Parameters

Name Type Description Default
col str

Column name to suffix.

 required
suffix str

Suffix string to add (joined with _).

 required

Returns

Type Description
str

Column name with suffix added.

Examples

>>> panel_aware_suffix("sales", "lag_1")
'sales_lag_1'
>>> panel_aware_suffix("store_1__sales", "lag_1")
'store_1__sales_lag_1'

See Also

Source Code

View on GitHub

Show/Hide source 
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
def panel_aware_suffix(col: str, suffix: str) -> str:
    """Add a suffix to a column name while preserving the panel group prefix.

    For panel data columns (``<GROUP>__<SERIES>``), the suffix is appended
    to the series part: ``<GROUP>__<SERIES>_<SUFFIX>``.

    For global columns, the suffix is appended: ``<COLUMN>_<SUFFIX>``.

    Parameters
    ----------
    col : str
        Column name to suffix.
    suffix : str
        Suffix string to add (joined with ``_``).

    Returns
    -------
    str
        Column name with suffix added.

    Examples
    --------
    >>> panel_aware_suffix("sales", "lag_1")
    'sales_lag_1'
    >>> panel_aware_suffix("store_1__sales", "lag_1")
    'store_1__sales_lag_1'

    See Also
    --------
    - [`panel_aware_rename`][yohou.utils.panel.panel_aware_rename] : General-purpose panel-aware rename utility.

    """
    return panel_aware_rename(col, lambda member: f"{member}_{suffix}")