Skip to content

Conversation

@ReneSkukies
Copy link
Member

Updates the package to 0.4.

Breaking changes

  • kwargs of run_unfold() changed. This was necessary to incorporate mass univariate modeling
  • Everything that relies on PyMNE (basically loading data and handling raw objects) is now an extension, meaning PyMNE has to be explicitly loaded by the user. This means that run_unfold is also part of the extension
  • Renaming some variables/ arg/ kwargs

New feature

  • Mass univariate modeling (no overlap correction)

Addresses

#102
#101

TBD

  • Test for Mass-Univariate
  • Documentation overhaul

ReneSkukies and others added 4 commits November 4, 2025 14:07
run_unfold now checks the bf_vec input and runs either a mass univariate or an overlap corrected model.
Note that there will be a discontinuity with Unfold.jl because the user has to provide a time window tuple = (start, stop) for mass univariate analysis.
This turns PyMNE into a weakdep and shifts `bids_load_data()` and `run_unfold` to an extension.
@behinger
Copy link
Member

behinger commented Nov 6, 2025

this looks great - but why is run_unfold dependent on PyMNE - only because of the extract_data?

E.g. if I implement a custom file-loader and dont need preprocessing, shouldnt I be able to use run_unfold too?

@ReneSkukies
Copy link
Member Author

this looks great - but why is run_unfold dependent on PyMNE - only because of the extract_data?

E.g. if I implement a custom file-loader and dont need preprocessing, shouldnt I be able to use run_unfold too?

Yes, I thought about that. So far my only solution for this would be to check if the data in the DataFrame is a Matrix or a raw object (though we can't check for Python raw without PyMNE being loaded...), and if it's raw, then use extract data, otherwise use the Matrix as is

@behinger
Copy link
Member

behinger commented Nov 6, 2025

You could have a catch-all that errors (with a hint to try loading pymne), a default case with providing matrices, and then the special case MNE Raw object?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fit non-overlap corrected data (i.e. mass-univariate modeling) Dismiss PyMNE as dependency

3 participants