nxcals.api.extraction.data.builders.DataFrame.melt

DataFrame.melt(ids: Union[ColumnOrName, List[ColumnOrName], Tuple[ColumnOrName, ...]], values: Optional[Union[ColumnOrName, List[ColumnOrName], Tuple[ColumnOrName, ...]]], variableColumnName: str, valueColumnName: str) → DataFrame

Unpivot a DataFrame from wide format to long format, optionally leaving identifier columns set. This is the reverse to groupBy(…).pivot(…).agg(…), except for the aggregation, which cannot be reversed.

melt() is an alias for unpivot().

New in version 3.4.0.

Parameters:

ids (str, Column, tuple, list, optional) – Column(s) to use as identifiers. Can be a single column or column name, or a list or tuple for multiple columns.
values (str, Column, tuple, list, optional) – Column(s) to unpivot. Can be a single column or column name, or a list or tuple for multiple columns. If not specified or empty, use all columns that are not set as ids.
variableColumnName (str) – Name of the variable column.
valueColumnName (str) – Name of the value column.

Returns:

Unpivoted DataFrame.

Return type:

DataFrame