INNER CODE UNIT · Python
clean_columns
aeturrell/skimpy · src/skimpy/__init__.py:889
def clean_columns(
df: pd.DataFrame | pl.DataFrame,
case: str = "snake",
replace: dict[str, str] | None = None,
remove_accents: bool = True,
) -> pd.DataFrame | pl.DataFrame:
"""Clean messy column names in a pandas dataframe.
Args:
df (pd.DataFrame | pl.DataFrame): Dataframe from which column names are to be cleaned.
case (str, optional): The desired case style of the column name. Defaults to "snake".
- 'snake' produces 'column_name';
- 'kebab' produces 'column-name';
- 'camel' produces 'columnName';
- 'pascal' produces 'ColumnName';
- 'const' produces 'COLUMN_NAME';
- 'sentence' produces 'Column name';