Is there a way to show the "directory" tree of the files in each mne.datasets?

Open
#10,799 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start with the mne.datasets documentation, especially the sample.data_path docstring, and review the existing print_dir_tree idea. Compare this with the datasets index page to determine where each dataset's directory tree should appear. Done means users can see the relevant file and subdirectory layout without downloading the dataset.

Written by the indexing model from the issue text.

Description

ENH
Describe the new feature or enhancement

When a developer is using the datasets available in mne.datasets e.g. https://mne.tools/stable/generated/mne.datasets.sample.data_path.html

then usually they actually don't know what's in the dataset, so they probably would need to inspect the entire folder to understand the filenames and subdirectories. It would be nice to see the file directory within each docstring to enable a more seamless dev experience.

Describe your proposed implementation

Idk how, but somehow piping the output of something like print_dir_tree of each datasets into their respective docstring?

Describe possible alternatives

Someone can just download the dataset I suppose and inspect it.

Alternatively, perhaps this page can be updated and linked within each dataset function? https://mne.tools/stable/overview/datasets_index.html#datasets

Additional comments

The idea came up in https://github.com/mne-tools/mne-connectivity/pull/100#discussion_r902953820

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mne-tools/mne-python

All issues in mne-tools/mne-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.