Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MNT] - Update example data file info & usage #350

Merged
merged 4 commits into from
Feb 11, 2025
Merged

[MNT] - Update example data file info & usage #350

merged 4 commits into from
Feb 11, 2025

Conversation

TomDonoghue
Copy link
Member

Responds to #312

I did a quick check through for information on the data files we use, and added a description to the README file in the data folder to add the basic information there. Notably, it adds a brief description of what the data is, sampling rate, and related publication. Having moved this info, I removed a bit of info in the tutorials themselves.

Also, we have a pre-computed filtered version of the DBS data file, and I don't remember why. It's barely used in the tutorials, and where it was (instantaneous measures tutorial) there's not really any reason to, so I updated this tutorial to simply compute the filtered version. This means that data_sample_1_filt is now not used anymore. I don't think we should remove it, at least for now (if we did, anyone running an older example with load_ndsp_data that uses it would get an error, which I don't think helps anything - so I think we can consider the file deprecated, but leave it there for now.

@neurodsp-tools neurodsp-tools deleted a comment from codecov bot Feb 11, 2025
Copy link
Member

@ryanhammonds ryanhammonds left a comment

Choose a reason for hiding this comment

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

Looks good. The only thing I noticed is that sample_data_1_filt.npy is no longer used anywhere, I think. So should it be dropped from data/?

Edit: nevermind! just re-read your original comment

@TomDonoghue TomDonoghue merged commit 8f77e42 into main Feb 11, 2025
10 checks passed
@TomDonoghue TomDonoghue deleted the data_info branch February 11, 2025 03:50
@neurodsp-tools neurodsp-tools deleted a comment from codecov bot Feb 11, 2025
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.

2 participants