Base functionality, sphinx and PyPi config#3
Conversation
There was a problem hiding this comment.
This file will be removed after I've created the examples for EEGPhasePy usage. Keeping it here for now for reference
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
christianbrodbeck
left a comment
There was a problem hiding this comment.
Added some generic comments. For more detailed review, could you fill in the sphinx API documentation page, and add some usage examples? Sphinx-gallery may work well.
Co-authored-by: Christian Brodbeck <christianmbrodbeck@gmail.com>
Co-authored-by: Christian Brodbeck <christianmbrodbeck@gmail.com>
Co-authored-by: Christian Brodbeck <christianmbrodbeck@gmail.com>
…ePy into feat/new-estimators
Thanks @christianbrodbeck, I've updated the PR based on your comments |
mus1223
left a comment
There was a problem hiding this comment.
Left comments for sections: EEGPhasePy installation, ETP-based phase estimation, and the Alpha phase estimation using ETP pages.
For installation, main points are describing prior packages needed, and ensuring latest version of eegphasepy installs with provided command.
For ETP-based phase estimation page, main points are ensuring operability with Python 3.10 (or disclaimer to upgrade), some formatting notes, and additional recommendations to add.
For Alpha phase estimation using ETP page, main points are to reduce redundancy of repeating same code blocks, and displaying the expected figures with interpretation.
mus1223
left a comment
There was a problem hiding this comment.
Review done for the following pages:
Alpha phase estimation using ETP
Autoregressive phase estimation
Bayesian optimization of PHASTIMATE parameters
Genetic optimization of PHASTIMATE parameters
Alpha phase estimation using PHASTIMATE
Optimizing PHASTIMATE parameters
Some main points are adding further explanation/rationale when needed, adding the output figures/stats themselves on to the tutorial along with their explanation, some potential inaccuracies with the stats values printed in some examples, and other considerations.
mus1223
left a comment
There was a problem hiding this comment.
Completed review for the following pages:
Plotting
Phase estimation statistics
Polar histograms
API reference
Main comments including providing more explanation where needed, typos, and missing information (particularly on API reference page)
…e checking to account for float and int
…ues with other python versions before publishing
…on optimization and more consistent phase parameters
This PR includes all of the base EEGPhasePy functionality:
API reference is also included in this PR using the readthedocs template