Skip to content

Commit

Permalink
docs(profiles): profile extension
Browse files Browse the repository at this point in the history
  • Loading branch information
sbrugman committed Aug 19, 2022
1 parent 581e63c commit e859530
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/source/profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,20 @@ The comparisons registry can be consulted for available comparisons:
print(Profiles.get_keys())
Profile extensions
------------------

How to enable profile extensions:

- Install the required package(s). This can be achieved via ``popmon``'s extras: ``pip install popmon[extension_name]``
- To show the profile values in your report:
- Include the relevant values to the ``show_stats`` list: ``settings.report.show_stats.append("[value_prefix]*")`` or
- Show all statistics: ``settings.report.extended_report = True``

Available profile extensions:

- `diptest <popmon/extensions/profile_diptest.py>`_: Hartigan & Hartigan's dip test for unimodality. Available for 1D numerical histograms. Uses the `diptest package <https://github.com/rurlus/diptest>`_ by Ralph Urlus.


Custom profiles
---------------
Expand Down

0 comments on commit e859530

Please sign in to comment.