Skip to content

Support explicitly setting a dimension order with to_dataframe() - #4333

Merged
dcherian merged 6 commits into
pydata:masterfrom
Thomas-Z:to_dataframe_dimensions_order
Aug 14, 2020
Merged

Support explicitly setting a dimension order with to_dataframe()#4333
dcherian merged 6 commits into
pydata:masterfrom
Thomas-Z:to_dataframe_dimensions_order

Conversation

@Thomas-Z

@Thomas-ZThomas-Z commented Aug 11, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

@max-sixty

max-sixty commented Aug 11, 2020

Copy link
Copy Markdown
Collaborator

Great, thanks @Thomas-Z , LGTM

Does anyone have thoughts on the kwarg name? dim_order seems reasonable, though IIRC we don't use it elsewhere

@dcherian

dcherian commented Aug 11, 2020

Copy link
Copy Markdown
Contributor

How about dims: Iterable[Hashable]?

@Thomas-Z

Thomas-Z commented Aug 11, 2020•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Hello,

I actually followed @shoyersuggestion to use to_dask_dataframe parameter name.

And I just realized I only did half the work. I'll add this parameter to DataArray.to_dataframe if you validate this name.

@dcherian

dcherian commented Aug 11, 2020

Copy link
Copy Markdown
Contributor

OK consistency with to_dask_dataframe is a good idea. Maybe stick with dim_order for now and we can change both later if someone really wants it?

@shoyer

shoyer commented Aug 11, 2020

Copy link
Copy Markdown
Member

I like dim_order a little bit better than dims because it's clear that you need supply all the dimensions, not just a subset (which is usually the case for dims)

shoyer
shoyer reviewed Aug 11, 2020
View reviewed changes
Comment threadxarray/core/dataset.py Outdated
Comment on lines +4558 to +4564
if dim_order is None:
dim_order = list(self.dims)
elif set(dim_order) != set(self.dims):
raise ValueError(
"dim_order {} does not match the set of dimensions on this "
"Dataset: {}".format(dim_order, list(self.dims))
)

@shoyershoyerAug 11, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could make a small helper method _normalize_dim_order() that we could use both here and in to_dask_dataframe?

@Thomas-Z

Thomas-Z commented Aug 11, 2020

Copy link
Copy Markdown
ContributorAuthor

Do we want DataArray.to_dataframe to be consistent with Dataset.to_dataframe regarding the default dimension ordering (i.e. alphabetically) or do we want to keep the current behavior (DataArray.dims order)?

@shoyer

shoyer commented Aug 11, 2020

Copy link
Copy Markdown
Member

Do we want DataArray.to_dataframe to be consistent with Dataset.to_dataframe regarding the default dimension ordering (i.e. alphabetically) or do we want to keep the current behavior (DataArray.dims order)?

DataArray.to_dataframe() should keep the current behavior based on the dimension order.

@tzilio-cls
#4331: Adding dim_order parameter to DataArray.to_dataframe.
c5b2c17
Refactoring some code, fixing some docstring.
dcherian
dcherian reviewed Aug 14, 2020
View reviewed changes

@dcheriandcherian left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Thomas-Z; just one minor comment. Can you add a note to whats-new.rst

Comment threadxarray/core/dataarray.py
shoyer
shoyer approved these changes Aug 14, 2020
View reviewed changes
Comment threadxarray/core/dataarray.py
@dcherian

dcherian commented Aug 14, 2020

Copy link
Copy Markdown
Contributor

Thanks @Thomas-Z . I see this is your first PR here. Welcome to xarray!

@dcherian
dcherian merged commit 1f45bca into pydata:masterAug 14, 2020
@max-sixty

max-sixty commented Aug 14, 2020

Copy link
Copy Markdown
Collaborator

Thanks @Thomas-Z ! Great to have you as a contributor

@Thomas-Z

Thomas-Z commented Aug 15, 2020

Copy link
Copy Markdown
ContributorAuthor

My pleasure.
I've been a user for a few years now, I'll gladly give something back whenever I can.

dcherian added a commit to dcherian/xarray that referenced this pull request Aug 15, 2020
@dcherian
Merge remote-tracking branch 'upstream/master' into propagate-attrs
b86623c
* upstream/master: (34 commits)
Fix bug in computing means of cftime.datetime arrays (pydata#4344)
fix some str accessor inconsistencies (pydata#4339)
pin matplotlib in ci/requirements/doc.yml (pydata#4340)
Clarify drop_vars return value. (pydata#4244)
Support explicitly setting a dimension order with to_dataframe() (pydata#4333)
Increase support window of all dependencies (pydata#4296)
Implement interp for interpolating between chunks of data (dask) (pydata#4155)
Add @mathause to current core developers. (pydata#4335)
install sphinx-autosummary-accessors from conda-forge (pydata#4332)
Use sphinx-accessors-autosummary (pydata#4323)
ndrolling fixes (pydata#4329)
DOC: fix typo argmin -> argmax in DataArray.argmax docstring (pydata#4327)
pin sphinx to 3.1(pydata#4326)
nd-rolling (pydata#4219)
Implicit dask import 4164 (pydata#4318)
allow customizing the inline repr of a duck array (pydata#4248)
silence the known docs CI issues (pydata#4316)
enh: fixedpydata#4302 (pydata#4315)
Remove all unused and warn-raising methods from AbstractDataStore (pydata#4310)
Fix map_blocks example (pydata#4305)
...
dcherian added a commit to dcherian/xarray that referenced this pull request Aug 16, 2020
@dcherian
Merge remote-tracking branch 'upstream/master' into fix/4107
1ea8666
* upstream/master: (40 commits)
Fix bug in computing means of cftime.datetime arrays (pydata#4344)
fix some str accessor inconsistencies (pydata#4339)
pin matplotlib in ci/requirements/doc.yml (pydata#4340)
Clarify drop_vars return value. (pydata#4244)
Support explicitly setting a dimension order with to_dataframe() (pydata#4333)
Increase support window of all dependencies (pydata#4296)
Implement interp for interpolating between chunks of data (dask) (pydata#4155)
Add @mathause to current core developers. (pydata#4335)
install sphinx-autosummary-accessors from conda-forge (pydata#4332)
Use sphinx-accessors-autosummary (pydata#4323)
ndrolling fixes (pydata#4329)
DOC: fix typo argmin -> argmax in DataArray.argmax docstring (pydata#4327)
pin sphinx to 3.1(pydata#4326)
nd-rolling (pydata#4219)
Implicit dask import 4164 (pydata#4318)
allow customizing the inline repr of a duck array (pydata#4248)
silence the known docs CI issues (pydata#4316)
enh: fixedpydata#4302 (pydata#4315)
Remove all unused and warn-raising methods from AbstractDataStore (pydata#4310)
Fix map_blocks example (pydata#4305)
...
@mathausemathause mentioned this pull request Aug 16, 2020
Merged
3 tasks
@hammer

hammer commented Aug 19, 2020

Copy link
Copy Markdown

Just noting for GitHub metadata purposes that this PR addresses the Dataset.to_dataframe annotation request in #4238

This was referenced Oct 21, 2024
Closed
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shoyershoyershoyer approved these changes
@dcheriandcheriandcherian approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support explicitly setting a dimension order with to_dataframe()

6 participants

@Thomas-Z@max-sixty@dcherian@shoyer@hammer@tzilio-cls