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

🐛 Correct Threshold Censor Regressor syntax #115

Merged
merged 2 commits into from
Sep 20, 2021
Merged

Conversation

shnizzedy
Copy link
Member

@shnizzedy shnizzedy commented Sep 14, 2021

Fixes

Fixes #114 by @shnizzedy

Description

Updates the Regressor component to:

  • change the thresholds key under Censor from threshold to thresholds
  • make the thresholds lists of dictionaries instead of dictionaries
  • include censor details in shorthand displayed in GUI

While testing this change, I noticed that some fields aren't included in the generated YAML if they aren't changed from the default. That's not typically an issue since C-PAC will use values from the default pipeline if the values aren't populated, but, for example, the default pipeline doesn't have any values for a custom regressor, so we should

Tests

Try to make a regressor with censoring at https://fcp-indi.github.io/C-PAC_GUI/versions/nightly/browser and in this branch locally (

C-PAC_GUI/README.md

Lines 8 to 10 in 0c942fb

yarn run clean:all
yarn
yarn run dev:browser
) and see the difference.

Here are the relevant sections of the YAML files generated during the screen captures below:

before

      - Name: scrub
        Censor:
          threshold:
            type: FD_P
            value: '0.2'
          number_of_previous_trs_to_censor: '3'
          number_of_subsequent_trs_to_censor: '3'

after

      - Name: scrub
        Censor:
          number_of_previous_trs_to_censor: '3'
          number_of_subsequent_trs_to_censor: '3'
          thresholds:
            - type: FD_P
              value: '0.2'

Screencaps

before.mp4
after.mp4

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I updated the changelog.
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

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.

1 participant