.. _sec-aggregators:

Aggregators
===========

The ``aggregators`` module is exposed as ``hl.agg``, e.g. ``hl.agg.sum``.

.. toctree::
    :maxdepth: 2

.. currentmodule:: hail.expr.aggregators

.. autosummary::

    collect
    collect_as_set
    count
    count_where
    counter
    any
    all
    take
    min
    max
    sum
    array_sum
    mean
    approx_quantiles
    approx_median
    stats
    product
    fraction
    hardy_weinberg_test
    explode
    filter
    inbreeding
    call_stats
    info_score
    hist
    linreg
    corr
    group_by
    array_agg
    downsample
    approx_cdf

.. autofunction:: collect
.. autofunction:: collect_as_set
.. autofunction:: count
.. autofunction:: count_where
.. autofunction:: counter
.. autofunction:: any
.. autofunction:: all
.. autofunction:: take
.. autofunction:: min
.. autofunction:: max
.. autofunction:: sum
.. autofunction:: array_sum
.. autofunction:: mean
.. autofunction:: approx_quantiles
.. autofunction:: approx_median
.. autofunction:: stats
.. autofunction:: product
.. autofunction:: fraction
.. autofunction:: hardy_weinberg_test
.. autofunction:: explode
.. autofunction:: filter
.. autofunction:: inbreeding
.. autofunction:: call_stats
.. autofunction:: info_score
.. autofunction:: hist
.. autofunction:: linreg
.. autofunction:: corr
.. autofunction:: group_by
.. autofunction:: array_agg
.. autofunction:: downsample
.. autofunction:: approx_cdf