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

BIDS App structure #1

Closed
effigies opened this issue Apr 20, 2023 · 4 comments
Closed

BIDS App structure #1

effigies opened this issue Apr 20, 2023 · 4 comments
Labels
effort: low Estimated low effort task good first issue Good for newcomers impact: high Estimated high impact task
Milestone

Comments

@effigies
Copy link
Member

effigies commented Apr 20, 2023

fmripost-aroma should be a BIDS app of the form:

fmripost-aroma <bids-dir> <out-dir> participant -d <fmriprep-dir> [OPTIONS]

The reason for taking the fmriprep directory as a separate derivative input is to permit the utility to retrieve some data from the raw dataset instead of relying entirely on the fmriprep derivatives. This will become necessary when fMRIPrep supports a minimal mode where only transforms are generated, so we might as well start the CLI where we expect it to end.

We should include the CLI arguments --melodic-dimensionality and --error-on-warnings, corresponding to the fMRIPrep arguments --aroma-melodic-dimensionality and --error-on-aroma-warnings.

@effigies effigies added effort: low Estimated low effort task good first issue Good for newcomers impact: high Estimated high impact task labels Apr 20, 2023
@effigies effigies added this to the 1.0 milestone Apr 20, 2023
@geowk
Copy link

geowk commented Apr 4, 2024

Is fmipost-aroma available for use or is it still in the beginning stages of development?

thanks.

-g

@tsalo
Copy link
Collaborator

tsalo commented Apr 17, 2024

It's still in the beginning stages.

@tsalo
Copy link
Collaborator

tsalo commented May 13, 2024

Given #12, I believe the CLI will need two basic configurations. In the first scenario (the original one above), users have the raw dataset and fMRIPrep derivatives with at least minimal outputs.

fmripost-aroma <bids-dir> <out-dir> participant -d fmriprep=<fmriprep-dir> [OPTIONS]

In the second scenario, users have fMRIPrep derivatives with resampling or full outputs.

fmripost-aroma <fmriprep-dir> <out-dir> participant [OPTIONS]

@tsalo
Copy link
Collaborator

tsalo commented Aug 28, 2024

I think it works with either one right now.

@tsalo tsalo closed this as completed Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: low Estimated low effort task good first issue Good for newcomers impact: high Estimated high impact task
Projects
None yet
Development

No branches or pull requests

3 participants