-
Notifications
You must be signed in to change notification settings - Fork 13
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
It has been suggested to more explicitly document how one can share their pyLossless derivative, and how others can used that derivative.
While telling others how to "share" their data is a bit out of scope for us IMO - I think that we could have some dedicated documentation on how to load pylossless derivatives.
Here is a proposal that I think achieves this.
- Store our pylossless derivative sample data on OSF - which addresses Moving the example data out of the repository #211
- Create a tutorial named something like "Load and use Pylossess outputs".
- In this tutorial, use Pooch or MNE's data fetcher to download the Pylossless derivative sample data from OSF
- Show users how to load the derivative. This might help with run_with_raw(raw) not saving derivatives by default #220
- Show users how to define a RejectionPolicy config to clean the loaded data. Show them how to adjust that config to achieve the cleaned state that they want.
- Link to this new tutorial from the current tutorial, for users who want to learn how to do more than apply the default rejection policy to their data.
I think that the outlined proposal would address this issue and #223
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation