Skip to content

Conversation

@vkrithika25
Copy link
Contributor

Description

Fixes #54

Type of change

  • New feature (non-breaking change which adds functionality)

Testing

  • Test A
    I added a test in test_cluster.py that takes sample questions from the harmony_example repository and creates input instruments for the clustering. In the test case, I then call the clustering function, with the plotting functionality turned on.

Since the Harmony Python package is used by the Harmony API (which is itself used by the R library and the web app), we need to avoid making any changes that break the Harmony API. Please also run the Harmony API unit tests and check that the API still runs with your changes to the Python package: https://github.com/harmonydata/harmonyapi

Test Configuration

  • Library version:
  • OS:
  • Toolchain:

Checklist

  • My code follows the style guidelines of this project. I have applied a Linter (recommended: Pycharm's code formatter) to make my whitespace consistent with the rest of the project.
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • The Harmony API is not broken by my change to the Harmony Python library
  • If I introduced a new feature, I documented it (e.g. making a script example in the script examples repository so that people will know how to use it.

@woodthom2
Copy link
Contributor

Thanks a lot @vkrithika25 !

@woodthom2 woodthom2 closed this Dec 6, 2024
@woodthom2 woodthom2 reopened this Dec 6, 2024
@woodthom2 woodthom2 merged commit fb0b065 into harmonydata:main Dec 6, 2024
2 checks passed
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.

Add clustering to Harmony Python library

2 participants