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

Allow --derivatives to be named #3260

Closed
tsalo opened this issue Mar 25, 2024 · 1 comment · Fixed by #3264
Closed

Allow --derivatives to be named #3260

tsalo opened this issue Mar 25, 2024 · 1 comment · Fixed by #3264
Labels

Comments

@tsalo
Copy link
Collaborator

tsalo commented Mar 25, 2024

What would you like to see added in fMRIPrep?

In #3252, we started creating DatasetLinks for derivative datasets passed through the --derivatives parameter. However, because there's no easy way to infer what each derivative dataset actually is, we're labeling them as deriv-<index> in the DatasetLinks. I think the DatasetLinks and BIDS URIs throughout the derivatives would be more interpretable if users could label their input derivative datsets.

Do you have any interest in helping implement the feature?

Yes

Additional information / screenshots

I was thinking something like:

fmriprep ... --derivatives smriprep=/path/to/smriprep
@tsalo tsalo added the feature label Mar 25, 2024
@effigies
Copy link
Member

Yes. I believe I actually implemented this in the wrapper but not the actual cli. I agree this is where we should go.

effigies added a commit that referenced this issue Mar 29, 2024
Closes #3260.

## Changes proposed in this pull request

- Copy over `ToDict` action from fmriprep-docker over to the main CLI
parser.
- Modify the Config to handle named derivative paths.
- E.g., `--derivatives anat=/path/to/smriprep` --> `DatasetLinks =
{'anat': '/path/to/smriprep'}`
- Infer derivative name from the folder name of the derivative path if
it isn't labeled.
- E.g., `--derivatives /path/to/smriprep` --> `DatasetLinks =
{'smriprep': '/path/to/smriprep'}`

---------

Co-authored-by: Chris Markiewicz <effigies@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants