Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate graphic reports for phys2bids outputs #464

Open
wants to merge 21 commits into
base: master
Choose a base branch
from

Conversation

me-pic
Copy link

@me-pic me-pic commented Apr 18, 2024

Closes #131, #407

The PR solved the issues in #407 with the proposed changes mentioned below.
The PR #407 was itself a follow-up of #243

Proposed Changes

  • Restrict bokeh version
  • Match bokehJS version to bokeh version
  • Remove x axes constraints

Change 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)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

Copy link

codecov bot commented Apr 18, 2024

Codecov Report

Attention: Patch coverage is 98.78049% with 1 line in your changes missing coverage. Please review.

Project coverage is 91.72%. Comparing base (02cf7c6) to head (924ea5f).
Report is 6 commits behind head on master.

Files with missing lines Patch % Lines
phys2bids/reporting/html_report.py 98.71% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #464      +/-   ##
==========================================
+ Coverage   91.15%   91.72%   +0.57%     
==========================================
  Files           8        9       +1     
  Lines        1006     1088      +82     
==========================================
+ Hits          917      998      +81     
- Misses         89       90       +1     
Files with missing lines Coverage Δ
phys2bids/cli/run.py 96.55% <100.00%> (+0.12%) ⬆️
phys2bids/phys2bids.py 87.36% <100.00%> (+0.20%) ⬆️
phys2bids/reporting/html_report.py 98.71% <98.71%> (ø)

@smoia smoia changed the title Generate report with phys2bids outputs Generate graphic reports for phys2bids outputs Apr 18, 2024
@smoia
Copy link
Member

smoia commented Apr 18, 2024

@me-pic this is awesome!!! Can you look into the readthedocs failure, please?

@smoia smoia requested a review from 62442katieb April 18, 2024 21:05
@me-pic
Copy link
Author

me-pic commented Apr 19, 2024

@smoia Not sure exactly what is happening with the doc... Been able to build it locally without any error using sphinx-build. Any hint on what I could check ?

@smoia
Copy link
Member

smoia commented Apr 19, 2024

No idea - I think it's happening also in #462. It seems to be something about the phys2bids.phys2bids module import?

@smoia
Copy link
Member

smoia commented Apr 19, 2024

@me-pic probably the best option is to update the documentation configuration (as well as sphinx packages version). Maybe we can open a new PR, trying to fit phys2bids docs into nigsp's configuration (it's more recent): https://github.com/MIPLabCH/nigsp/tree/master/docs

@me-pic
Copy link
Author

me-pic commented Apr 22, 2024

@smoia Thank you ! Will take a look next week.

@github-actions github-actions bot added Testing This is for testing features, writing tests or producing testing code Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog labels Jul 8, 2024
@github-actions github-actions bot added the Documentation This issue or PR is about the documentation label Jul 8, 2024
@smoia
Copy link
Member

smoia commented Oct 8, 2024

@me-pic do you still have problems with the docs?

@me-pic
Copy link
Author

me-pic commented Oct 9, 2024

@smoia Yes.. I can't figure why, and I don't have any problem building it locally :(

@m-miedema m-miedema self-requested a review October 29, 2024 19:01
Copy link
Member

@m-miedema m-miedema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this with the data I'm using for the Repronim demo and it is mostly working - looks great! However, for this data there are four channels being saved, but only the first two generate plots in the report (the next two are completely missing). As well, I'm puzzled by the "phys2BIDS Output Directory" column. Is it meant to show the structure of the BIDS-ified files? Right now, it shows some assets (a bit confusing/distracting) and then the files in the folder that I ran phys2bids from (not the output directory or the files therein).

@smoia
Copy link
Member

smoia commented Oct 29, 2024

Can you post a screenshot please?

@m-miedema
Copy link
Member

Can you post a screenshot please?

screenshot

@me-pic
Copy link
Author

me-pic commented Dec 2, 2024

For the phys2bids output directory, is that better ?
Screenshot from 2024-12-02 15-41-58

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation This issue or PR is about the documentation Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog Testing This is for testing features, writing tests or producing testing code
Projects
Status: PR is being reviewed
Development

Successfully merging this pull request may close these issues.

Generate a report with all the outputs
4 participants