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] ADNI-to-BIDS : add Field Mapping (FMAP) specificities #1199

Merged

Conversation

AliceJoubert
Copy link
Contributor

@AliceJoubert AliceJoubert commented Jun 3, 2024

Complete ADNI-to-BIDS documentation :

  • Add description for FMAP process steps
  • Add known problematic subjects/sessions

@AliceJoubert AliceJoubert self-assigned this Jun 3, 2024
@AliceJoubert AliceJoubert added converter doc Documentation (wiki, source code, etc.) labels Jun 3, 2024
@AliceJoubert AliceJoubert marked this pull request as ready for review June 3, 2024 14:38
Copy link
Member

@NicolasGensollen NicolasGensollen left a comment

Choose a reason for hiding this comment

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

Thanks @AliceJoubert !

I think this looks good but I would be a bit clearer on the fact that FMAP conversion is new and experimental (see comment).

docs/Converters/ADNI2BIDS.md Outdated Show resolved Hide resolved
@AliceJoubert
Copy link
Contributor Author

Thanks for the review @NicolasGensollen ! I modified to add your suggestion. Do you see anything else ?

@@ -100,6 +102,11 @@ The user can easily modify this file if they want to convert additional clinical
For further details regarding clinica data, we recommend to look at the [ADNI Data Package
](https://adni.bitbucket.io/index.html) developed by the Alzheimer's Disease Neuroimaging Initiative.

??? failure "Warning : Field Mapping modality"
Copy link
Member

Choose a reason for hiding this comment

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

I don't see this block in the rendered documentation: https://aramislab.paris.inria.fr/clinica/docs/public/PR-1199/Converters/ADNI2BIDS/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see it either, as well as all the changes I made in the last commit (ex : removing the "except for FMAP" part as suggested). Did I miss something I should have done for it to appear ?

Copy link
Member

Choose a reason for hiding this comment

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

Indeed, there is a bug in the automatic documentation deployment pipeline... 😱 I'll open a PR to fix it.
I've updated the docs for this PR manually and the changes you made seem to be there.
Could you just double check that everything looks good in the rendered page ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not sure if it is still relevant now that you merged the PR but no I can't see the new changes in the rendered page. I will rebase a bit later :-)

Copy link
Member

Choose a reason for hiding this comment

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

That's weird, I can see them.

Copy link
Member

@NicolasGensollen NicolasGensollen left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @AliceJoubert !
I'm gonna merge since I can see the changes in the rendered doc and they look good to me.

@NicolasGensollen NicolasGensollen merged commit 3c59fd8 into aramis-lab:dev Jun 6, 2024
13 of 15 checks passed
@AliceJoubert AliceJoubert deleted the add_fmap_to_documentation branch June 7, 2024 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
converter doc Documentation (wiki, source code, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants