👔 Move creation of correlations.json to cpac-correlations CLI

[shnizzedy]

Fixes

Related to FCP-INDI/C-PAC#1211 (comment) by @shnizzedy

Description

Updates cpac-correlations/cpac_correlations CLI and its underlying functions to generate the files necessary for childmindresearch/slurm_testing to produce the interactive heatmap and GitHub comment via FCP-INDI/C-PAC_regression_dashboard:

• correlations.json
• PNG images
• txt files

Technical details

• Documents and updates some typehints
• Migrates from deprecated CircleCI image
• Updates some style rules to match C-PAC code style
• Applies the subject-session labels to the correlation coefficients instead of averaging by site
• Coerces n_cpus to int
• Makes args optional to facilitate calling as a function or from the CLI
• Adds a CHANGELOG

Screenshot

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the main 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.

[sgiavasis]

Love what you've done with this old script!