Generate docs #56
Generate docs #56
Conversation
There was a problem hiding this comment.
Thank you @maestroque for working on that ! It's really nice to have doc for phys2denoise 🎉 Just left some comments in my review. Let me know if you have any question / want to discuss them !
|
|
||
| .. _basic_installation: | ||
|
|
||
| Developer installation |
There was a problem hiding this comment.
Wondering if there is a reason to only have the dev installation here
|
|
||
| # Load the physiological data | ||
| sample_rate = 1000 | ||
| physio = io.load_physio('path/to/physiological/data', fs=sample_rate) |
There was a problem hiding this comment.
At some point it would be nice to provide actual data for people to play around
| @@ -0,0 +1,10 @@ | |||
|
|
|||
| Contents | |||
There was a problem hiding this comment.
I think for now it is ok, but at some point it would be necessary to provide a bit more context/use cases for that package. You can check peakdet doc for an example
|
|
||
| The benefit of using a Physio object other than the encapsulation of all the desired parameters in a single object is the fact that | ||
| the object retains a history of all the operations performed on it. This allows for easy debugging and reproducibility of the results. | ||
| For further information refer to the :py:mod:`physutils` documentation. |
There was a problem hiding this comment.
Maybe I'm not aware of it, but it looks like for the moment there is not physutils documentation. So since you are referring to it, I'm wondering if we should work on the physutils docs before merging that PR.
There was a problem hiding this comment.
I can generate some docs only including API for the time being.
|
|
||
| from phys2denoise.metrics.chest_belt import respiratory_variance_time | ||
|
|
||
| # Given that the respiratory signal is stored in `data`, the peaks in `peaks`, the troughs in `troughs` |
There was a problem hiding this comment.
Here do you mean the respiratory signal is stored in physio ? However I think it might be less confusing to keep the name you used in the comment and use data in the function i.e. respiratory_variance_time(data, peaks, troughs, sample_rate)
There was a problem hiding this comment.
Also do you think it would be a good idea to show in that example how users would load their data ?
There was a problem hiding this comment.
thanks, good catch
There was a problem hiding this comment.
I think loading the data is really dependent on the format the user is using, idk if it would be fitting here
docs/user_guide/metrics.rst
Outdated
| Without using a Physio object | ||
| ############################# | ||
|
|
||
| However, if the use of :py:mod:`physutils` is not preferred, the metrics can be also computed without it. The following |
There was a problem hiding this comment.
Wondering if it would make more sense to say if the use of the physio object rather than if the use of physutils. What do you think ?
| from phys2denoise.metrics.utils import export_metric | ||
|
|
||
| RVT = respiratory_variance_time( | ||
| resp.data, resp.peaks, resp.troughs, resp.fs, lags=(0, 4, 8, 12) |
There was a problem hiding this comment.
I might have missed it but I don't see where resp was defined previously
|
@me-pic I implemented your suggestions, it should hopefully be gtg |
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
@maestroque Thank you ! I've pushed some changes directly on your branch. Just changed some sentence formulation and added the warning about the potential installation issue regarding matplotlib versioning
Closes #
Generate a documentation page for
phys2denoise, including showcase of the utilization of the Physio object within the packageChange Type
bugfix(+0.0.1)minor(+0.1.0)major(+1.0.0)refactoring(no version update)test(no version update)infrastructure(no version update)documentation(no version update)otherChecklist before review