Adding high level plotting API

[manuguth]

Summary

This pull request introduces the following changes

• Adds a new high level plotting API (hlplots) to be able to plot ROC curves etc. with less lines of code

Relates to the following issues

• relates to Reducing boilerplate / adding high level functions #122

TODOs

• Add full integration for c-tagging
• add all the tests for the results module
• add documentation

Conformity

• Changelog entry
• Documentation

[samvanstroud]

Hi @manuguth, any update on this?

[manuguth]

Hi @manuguth, any update on this?

It's on my ToDo, hope to get to it soon
the skeleton is there, it needs a bit of tuning

[samvanstroud]

keen to see this merged! I had a couple of discussion points.

[codecov-commenter]

Codecov Report

Merging #128 (e2d516e) into main (c4b4cac) will increase coverage by 0.72%.
The diff coverage is 99.13%.

@@            Coverage Diff             @@
##             main     #128      +/-   ##
==========================================
+ Coverage   95.78%   96.50%   +0.72%     
==========================================
  Files          23       30       +7     
  Lines        2206     2663     +457     
==========================================
+ Hits         2113     2570     +457     
  Misses         93       93              

Impacted Files	Coverage Δ
puma/tests/utils/test_generate.py	100.00% <ø> (ø)
puma/utils/generate.py	100.00% <ø> (ø)
puma/hlplots/results.py	97.82% <97.82%> (ø)
puma/hlplots/tagger.py	98.46% <98.46%> (ø)
puma/tests/hlplots/test_results.py	99.25% <99.25%> (ø)
puma/hlplots/__init__.py	100.00% <100.00%> (ø)
puma/tests/hlplots/test_tagger.py	100.00% <100.00%> (ø)
puma/tests/utils/test_discriminant.py	100.00% <100.00%> (ø)
puma/utils/__init__.py	71.05% <100.00%> (+0.78%)	⬆️
puma/utils/discriminant.py	100.00% <100.00%> (ø)
... and 4 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[manuguth]

@samvanstroud @jobirk @afroch @philippgadow I now have a first fully implemented suggestion for the high level API (some small things are still missing though most of it is there).
Could you give me feedback about the current implementation? Afterwards I would finalise the tests, docs etc

[afroch]

Ok so overall I really like the structure of the new API. I think it's really nice to have it that way

[joschkabirk]

Really like the implementation 🎉