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

DOC : add how to read fmriprep visual report #21

Open
wants to merge 26 commits into
base: mkdocs
Choose a base branch
from

Conversation

celprov
Copy link
Contributor

@celprov celprov commented Dec 19, 2022

Add a document to the Nipreps documentation explaining how to read fMRIprep visual report.
For each visualisation, the document answers the following questions :

  • What is being shown and what does it mean for my data?
  • What can I expect to see in “better” reports?
  • What can I expect to see in “worse” reports?
  • If I see a “bad” report, what should I do about it?

sarenseeley and others added 16 commits December 16, 2022 11:16
visualisation as the latter has been removed in the version 22.0.0 of
fMRIPrep
doc : Add SDC information under alignement of functional and anatomical
data
doc : add arrows to point at the apparent artifact caused by the
interpolation used for visualisation
…into quality check the three preprocessing step evaluated here
fix : replace gray matter and white matter by their abbreviations
fix : Add precision about the fact that the brain mask extracted from
T1w and BOLD are different and they obey different exclusion criteria
@celprov celprov force-pushed the doc/howto_read_fmriprep_visual_report branch from 23f4af9 to 119bb98 Compare February 13, 2023 14:26
@celprov
Copy link
Contributor Author

celprov commented Feb 13, 2023

Hi @sarenseeley,
I hope my message finds you well. Would you mind reviewing the "How To Read fMRIPrep visual Report" I have adapted and completed from your original draft?

Additionally, I'm missing a few elements listed below. I would gladly welcome your help if you have more insights on the following :

  1. Can we spot quality issues in the global signal traces about the carpet plot ?
  2. Can we spot quality issues in the variance explained by t/aCompCor components ?
  3. How can we assess partial volume effect using correlations among nuisance regressors ?
  4. Can we give more details on the multiband and slice-timing artifacts in ICA-AROMA ?

Responded to questions in issue nipreps#21
@sarenseeley
Copy link

@celprov hopefully I did this correctly, but let me know if not!

Also, I'm wondering if instead of "good"/"bad" we should use "better"/"worse" (or similar terms) to avoid the document being read as prescriptive?

@celprov celprov marked this pull request as ready for review March 29, 2023 10:30
@celprov
Copy link
Contributor Author

celprov commented Mar 31, 2023

@oesteban @effigies could you please review this "How to read fMRIPrep visual report "?

PS can one of you also enable @esavary and me to assign reviewers to PR in this repository ?
Thank you!

@effigies
Copy link
Member

@celprov @esavary I've tried giving @nipreps/developers "triage" permissions on this repository. Does that do what you want? I don't fully understand the levels. I can increase permissions further if desired.

@celprov celprov requested review from effigies and oesteban March 31, 2023 13:19
@celprov
Copy link
Contributor Author

celprov commented Mar 31, 2023

@effigies Thank you it worked.

Copy link
Member

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Just some initial thoughts. I haven't done a thorough read-through of the content. My impression is that if I were reading this document, I would want a gross structure like:

  • Introduction
  • Structure of a report
    • Description of sections, probably mention the top bar for quick navigation
    • Suggested order of operations (check errors and summaries first, then walk through the reportlets)
  • Reportlet walkthrough
    • For each reportlet:
      • A good example
      • A description of what is being shown in the reportlet (could be taken directly from the captions in the reports)
      • A good/bad example for each thing presented in the reportlet

I think the current document focuses mostly on that last bullet. I feel like I would want my hand held a bit more if I were reading this for the first time.

Copy link
Member

Choose a reason for hiding this comment

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

This file looks like arrows on a white background. I don't know if it's missing layers or the brain images are in the wrong layer...

Copy link
Member

Choose a reason for hiding this comment

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

+1

docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
Copy link
Member

@oesteban oesteban left a comment

Choose a reason for hiding this comment

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

Just got through line 28. Will continue at some other time

Copy link
Member

Choose a reason for hiding this comment

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

+1

docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
docs/users/howto_read_fmriprep_visual_report.md Outdated Show resolved Hide resolved
@oesteban
Copy link
Member

What's the status of this? @celprov please look at my review whenever you are back :)

@celprov
Copy link
Contributor Author

celprov commented Aug 21, 2023

What's the status of this? @celprov please look at my review whenever you are back
@oesteban To be completely honest, it fell into the backlog, because it requires some work to guide better the audience (cf Chris comment) through the document and other tasks took priority.

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.

4 participants