Skip to content

lreshape and wide_to_long documentation (Closes #33417) #33418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Aug 19, 2020
Merged

lreshape and wide_to_long documentation (Closes #33417) #33418

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b9be776
references to lreshape and wide_to_long
tpanza Apr 9, 2020
4035c18
fix description of lreshape. fix format of lreshape docstring.
tpanza Apr 9, 2020
c638eea
remove whitespace in blank line
tpanza Apr 9, 2020
735a68e
reorder. Put lreshape near the end, next to wide_to_long
tpanza Apr 9, 2020
27747c7
Add reference to DataFrame.melt in pivot_table's See Also docstring
tpanza Apr 9, 2020
86ca0e3
whatsnew entry for GH33417
tpanza Apr 9, 2020
1b4e267
remove references to lreshape
tpanza Apr 12, 2020
09be7f7
Merge branch 'master' into reshape-doc
tpanza Apr 12, 2020
a603c65
Merge remote-tracking branch 'upstream/master' into reshape-doc
simonjayhawkins May 22, 2020
1713376
comment
simonjayhawkins May 22, 2020
7919201
Merge branch 'master' of github.com:pandas-dev/pandas into reshape-doc
tpanza Jun 21, 2020
be23734
remove wide_to_long from list of Reshaping, sorting, transposing Data…
tpanza Jun 21, 2020
4752d15
Merge remote-tracking branch 'upstream/master' into reshape-doc
WillAyd Aug 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/source/reference/frame.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ Reshaping, sorting, transposing
DataFrame.unstack
DataFrame.swapaxes
DataFrame.melt
wide_to_long
DataFrame.explode
DataFrame.squeeze
DataFrame.to_xarray
Expand Down
8 changes: 8 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6327,6 +6327,8 @@ def groupby(
duplicate values for one index/column pair.
DataFrame.unstack : Pivot based on the index values instead of a
column.
wide_to_long : Wide panel to long format. Less flexible but more
user-friendly than melt.

Notes
-----
Expand Down Expand Up @@ -6481,6 +6483,10 @@ def pivot(self, index=None, columns=None, values=None) -> "DataFrame":
--------
DataFrame.pivot : Pivot without aggregation that can handle
non-numeric data.
DataFrame.melt: Unpivot a DataFrame from wide to long format,
optionally leaving identifiers set.
wide_to_long : Wide panel to long format. Less flexible but more
user-friendly than melt.

Examples
--------
Expand Down Expand Up @@ -6925,6 +6931,8 @@ def unstack(self, level=-1, fill_value=None):
See Also
--------
%(other)s : Identical method.
wide_to_long : Wide panel to long format. Less flexible but more
user-friendly than melt.
pivot_table : Create a spreadsheet-style pivot table as a DataFrame.
DataFrame.pivot : Return reshaped DataFrame organized
by given index / column values.
Expand Down
51 changes: 44 additions & 7 deletions pandas/core/reshape/melt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,14 +118,43 @@ def melt(
@deprecate_kwarg(old_arg_name="label", new_arg_name=None)
def lreshape(data: DataFrame, groups, dropna: bool = True, label=None) -> DataFrame:
"""
Reshape long-format data to wide. Generalized inverse of DataFrame.pivot
Reshape wide-format data to long. Generalized inverse of DataFrame.pivot.

Accepts a dictionary, ``groups``, in which each key is a new column name
and each value is a list of old column names that will be "melted" under
the new column name as part of the reshape.

Parameters
----------
data : DataFrame
The wide-format DataFrame.
groups : dict
{new_name : list_of_columns}
dropna : boolean, default True
{new_name : list_of_columns}.
dropna : bool, default True
Do not include columns whose entries are all NaN.
label : None
Not used.

.. deprecated:: 1.0.0

Returns
-------
DataFrame
Reshaped DataFrame.

See Also
--------
melt : Unpivot a DataFrame from wide to long format, optionally leaving
identifiers set.
pivot : Create a spreadsheet-style pivot table as a DataFrame.
DataFrame.pivot : Pivot without aggregation that can handle
non-numeric data.
DataFrame.pivot_table : Generalization of pivot that can handle
duplicate values for one index/column pair.
DataFrame.unstack : Pivot based on the index values instead of a
column.
wide_to_long : Wide panel to long format. Less flexible but more
user-friendly than melt.

Examples
--------
Expand All @@ -143,10 +172,6 @@ def lreshape(data: DataFrame, groups, dropna: bool = True, label=None) -> DataFr
1 Yankees 2007 573
2 Red Sox 2008 545
3 Yankees 2008 526

Returns
-------
reshaped : DataFrame
"""
if isinstance(groups, dict):
keys = list(groups.keys())
Expand Down Expand Up @@ -236,6 +261,18 @@ def wide_to_long(
A DataFrame that contains each stub name as a variable, with new index
(i, j).

See Also
--------
melt : Unpivot a DataFrame from wide to long format, optionally leaving
identifiers set.
pivot : Create a spreadsheet-style pivot table as a DataFrame.
DataFrame.pivot : Pivot without aggregation that can handle
non-numeric data.
DataFrame.pivot_table : Generalization of pivot that can handle
duplicate values for one index/column pair.
DataFrame.unstack : Pivot based on the index values instead of a
column.

Notes
-----
All extra variables are left untouched. This simply uses
Expand Down