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

FIX: Rename use_syn config option to use_syn_sdc to match CLI #2101

Merged
merged 1 commit into from
Apr 24, 2020

Conversation

effigies
Copy link
Member

Changes proposed in this pull request

Proposing in case this is the correct fix.

  • FIX: Rename use_syn config option to use_syn_sdc to match CLI

Closes #1941 (again).

Documentation that should be reviewed

@auto-comment
Copy link

auto-comment bot commented Apr 24, 2020

Thank your for raising your pull request.

Some of the fMRIPRep maintainers will review your changes as soon as time permits.
I'm attaching below a Review Checklist for the reviewers, to check off during the
review.

PR Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide

  • As the reviewer I confirm that there are no conflicts of interest for me to review this work.

Please check what applies in the following aspects of the PR:

Code documentation

  • New functions and modules are documented following the guidelines.
  • Existing code required amendments in documentation and has been updated.
  • Sufficient inline comments ensure readability by other contributors in the long term.

Documentation site

  • The modifications to fMRIPrep in this PR do not require extra documentation. This is a common situation when a bug fix that does not change the code base substantially is submitted.
  • This PR requires documentation. The corresponding documentation will be submitted as an additional PR in the future.
  • This PR requires extra documentation, and will be included within this PR. Please check the boxes that apply best:
    • An existing feature is substantially modified, changing the interface and/or logic of a module.
    • A new feature is being added, therefore full documentation of it will be included
    • This PR addresses an error in existing documentation.
  • Yes, all expected sections of documentation were generated by the CI build, and look as expected

Tests

  • The new functionalities in this PR are covered by the existing tests
  • New test batteries have been included with this PR

Data

  • This PR does not require any additional data to be uploaded to OSF.
  • This PR requires additional data for tests.

Dependencies: smriprep

  • This PR does not require any update on smriprep; or
  • smriprep has correctly been pinned.

Dependencies: niworkflows

  • This PR does not require any update on niworkflows; or
  • niworkflows has correctly been pinned.

Dependencies: sdcflows

  • This PR does not require any update on sdcflows; or
  • sdcflows has correctly been pinned.

Dependencies: Nipype

  • This PR does not require any update on nipype; or
  • nipype has correctly been pinned.

Dependencies: other

  • This PR does not require any update on other dependencies; or
  • other dependencies have correctly been pinned.

Reports generated within CI tests

  • Yes, I have checked the reports of ds005 and they are not modified or the changes are as expected
  • Yes, I have checked the reports of ds054 and they are not modified or the changes are as expected
  • Yes, I have checked the reports of ds010 and they are not modified or the changes are as expected

@mgxd
Copy link
Collaborator

mgxd commented Apr 24, 2020

the cleanest way would probably be to add dest=use_syn to the parser argument

@effigies
Copy link
Member Author

I can do that, but why is that cleaner? SyN isn't SDC-specific, so use_syn is less clear to me.

Let me know if you still want me to switch.

@mgxd
Copy link
Collaborator

mgxd commented Apr 24, 2020

i meant in terms of lines changed, but IDRC

@effigies
Copy link
Member Author

I'd prefer keeping the variable name consistent with the CLI just to keep things simple.

@effigies effigies merged commit a0cc490 into nipreps:master Apr 24, 2020
@effigies effigies deleted the fix/use_syn_config branch April 24, 2020 18:05
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.

--use-syn-sdc no longer respected when --ignore fieldmaps is passed
2 participants