Support `create_index: bool` in `to_dataframe` to skip creating MultiIndex
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Is your feature request related to a problem?
stack lets a user skip creating a potentially expensive MultiIndex by passing create_index=False.
Describe the solution you'd like
We should support the same kwarg in to_dataframe for the same reason.
Describe alternatives you've considered
Expect the user to know that the MultiIndex creation is potentially expensive; and call reset_coords before-hand. This seems too niche.
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Dataset.to_dataframe entry point and compare its behavior with Dataset.stack(create_index=False), using the linked stack documentation as the reference. Add support for the create_index boolean so callers can skip MultiIndex creation, and verify that to_dataframe still produces the expected dataframe when the option is enabled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100