meta00 / vital_sqi

A package for physiological signal quality control
MIT License
30 stars 11 forks source link

~ retract apidoc app module exceptions #56

Closed bahp closed 3 years ago

bahp commented 3 years ago

There is an issue with the app module that probably raises an error in readthedocs. Although it works locally because it just skips the errors, it is very likely that readthedocs is just stopping if an error is raised. Please double check in your readthedocs account the compilations that failed and send me the info if you can.

Identified errors:

  1. Libraries in app missing: dash, psftp, dash_auth, boto3 (include in readme)
  2. utilities is imported with local path . and try: except (please fix)
  3. Libraries examples missing: plotly
  4. Generating the documentation API breaks if issues on imports (flake8)

Thank you!

works

codecov[bot] commented 3 years ago

Codecov Report

Merging #56 (b80c60b) into main (a41212b) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   34.80%   34.80%           
=======================================
  Files          29       29           
  Lines        2307     2307           
=======================================
  Hits          803      803           
  Misses       1504     1504           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a41212b...b80c60b. Read the comment docs.

meta00 commented 3 years ago
Screenshot 2021-05-25 at 10 19 37

Thanks, the attribute of SignalSQI and functionsplit_to_subsegmentswere renamed (or removed?) , @Koaha could you updateplot_read_signal.pyandplot_data_manipulation.py`, respectively?

Koaha commented 3 years ago

The plot_read_signal.py and plot_data_manipulation.py have been updated to load the toy dataset from the package. The official app branch will be merged after the demo to replace the old document in readthedocs (as currently, readthedocs refers to the old tools - labeling and exploration)

bahp commented 3 years ago

Thanks for the logs.

Please do not edit plot_read_signal.py at the moment (apart from the loading dataset), it is a sample script/pipeline I wanted to discuss with all of you on a meeting. The aim of the script is to describe better what I meant when I said "Lets make the most of the pandas library" which is great. I haven't double checked everything and I need to include the read by chunks part.

Thank you!