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

Creating nireports #22

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

SRSteinkamp
Copy link
Collaborator

This PR will implement the basis for creating html output using nireports.

Proposed Changes

  • Adding nireports to workflow and create .html outputs.

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!

@SRSteinkamp
Copy link
Collaborator Author

SRSteinkamp commented Jun 20, 2024

This PR should be more a basis for discussion of how to go further - it now creates a report in the outputdir.

Issues to discuss

  • Is a .yml file necessary, can we combine reportlets? (Help needed).
  • How to handle BIDS? PyBIDS
  • Rename plots to be more BIDS compatible

@SRSteinkamp
Copy link
Collaborator Author

As a very small next step, I added some clunky code to use at least some BIDS naming for outputs and removing the hardcoding of subject IDs.
It's not yet querying a BIDS dataset and creating a layout etc. - but I think BIDS format is at the very least implied.

@me-pic
Copy link
Contributor

me-pic commented Aug 27, 2024

Hey @SRSteinkamp ! I would be happy to help on that PR, if you need a second pair of eyes. Would it possible to summarize what needs to be done ?

@SRSteinkamp
Copy link
Collaborator Author

Just trying to put some life into this.

This PR is basically a prototype, which provides a CLI that can be pointed to a physio data file and to an output directory. It will then save the report (html), figures and metrics to that output directory.

So far it is using pybids to separate fileparts etc.

I think the general question/discussion for this PR is, is this enough for the beginning, then it would need some clean up and improvement.
Alternatively, we might want to discuss how the full workflow should look like (i.e. full BIDS-app style, traversing a BIDS etc.).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants