[MNT] - Update example data file info & usage#350
Merged
Conversation
ryanhammonds
approved these changes
Feb 11, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_filtis now not used anymore. I don't think we should remove it, at least for now (if we did, anyone running an older example withload_ndsp_datathat 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.