mne-tools / mne-tools/mne-python
Add verbosity to mne.connectivity.envelope_correlations()
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Feature description:
I propose adding verbosity to the mne.connectivity.envelope_correlations() function.
Currently, mne.connectivity.envelope_correlations() takes about two minutes to run on my Linux machine, and it does not output any text to the user indicating its progress. Because of the long run duration, it's easy to start worrying that the script has crashed when there is no progress feedback. Let's fix that!
I (@nordme) am happy to work on a PR for this.
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 by locating the definition of mne.connectivity.envelope_correlations() and inspect how this module handles verbosity or progress feedback elsewhere. Confirm the function's long-running path and identify the relevant tests; done means users receive useful progress output while the existing connectivity results remain unchanged.
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
- 45/100