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

Add --report-output-level parameter #848

Open
tsalo opened this issue Nov 7, 2024 · 7 comments
Open

Add --report-output-level parameter #848

tsalo opened this issue Nov 7, 2024 · 7 comments
Labels
enhancement New feature or request
Milestone

Comments

@tsalo
Copy link
Member

tsalo commented Nov 7, 2024

Summary

@mattcieslak and I discussed this today. The new parameter would be --report-output-level <root | subject | session> and would determine where HTML reports are written to.

If the user chooses session but the data are cross-sectional, QSIPrep will automatically change the level to subject with a warning.

This parameter can also be implemented in the preps, QSIRecon, and XCP-D.

@tsalo
Copy link
Member Author

tsalo commented Nov 13, 2024

@mattcieslak do you think we need this for the HBCD release?

@mattcieslak
Copy link
Collaborator

the html reports are currently going into the subject level by default, which is different from where qsiprep puts them (in the session directory). Since they're not being written to the output root it's probably Ok loris/chrainwise to have them where they are. The qsirecon derivatives layout is so different from qsiprep that it might not even be that much extra confusing to have the reports at a different level. wdyt?

@tsalo
Copy link
Member Author

tsalo commented Nov 13, 2024

AFAICT the HTML reports aren't going into the subject level in either package right now. Your session-wise QSIRecon PR will make it possible to write out the reports to the subject or session folder (though that won't be the default), but there's nothing like that for QSIPrep.

@mattcieslak
Copy link
Collaborator

ok, two admissions here. First, I was wrong about where the html reports are going in qsirecon. They're definitely going in the qsirecon-suffix/ directories. and second - I thought this issue was in qsirecon. I don't think we'll need to add anything like this for qsiprep.

@tsalo
Copy link
Member Author

tsalo commented Nov 13, 2024

I think the HBCD folks will want reports in session folders in the long run, so I still think we should add this to QSIPrep.

@mattcieslak
Copy link
Collaborator

they reports will end up there as long as the anat level is set to session, so no flag needed for hbcd right?

@tsalo
Copy link
Member Author

tsalo commented Nov 13, 2024

Discussed offline and we agreed to add the new parameter because it'll improve portability for cross-sectional datasets, but it's a low priority item and doesn't need to be done by the next release.

@tsalo tsalo added this to the 1.1.0 milestone Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants