Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix cdf docs #6478

Merged
merged 1 commit into from Jun 30, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions hail/python/hail/docs/aggregators.rst
Expand Up @@ -56,6 +56,7 @@ The ``aggregators`` module is exposed as ``hl.agg``, e.g. ``hl.agg.sum``.
.. autofunction:: sum
.. autofunction:: array_sum
.. autofunction:: mean
.. autofunction:: approx_quantiles
.. autofunction:: stats
.. autofunction:: product
.. autofunction:: fraction
Expand All @@ -71,3 +72,4 @@ The ``aggregators`` module is exposed as ``hl.agg``, e.g. ``hl.agg.sum``.
.. autofunction:: group_by
.. autofunction:: array_agg
.. autofunction:: downsample
.. autofunction:: approx_cdf
6 changes: 6 additions & 0 deletions hail/python/hail/docs/plot.rst
Expand Up @@ -19,13 +19,19 @@ Plot functions in Hail accept data in the form of either Python objects or :clas
.. autosummary::
:nosignatures:

cdf
pdf
smoothed_pdf
histogram
cumulative_histogram
histogram2d
scatter
qq
manhattan

.. autofunction:: cdf
.. autofunction:: pdf
.. autofunction:: smoothed_pdf
.. autofunction:: histogram
.. autofunction:: cumulative_histogram
.. autofunction:: histogram2d
Expand Down
2 changes: 1 addition & 1 deletion hail/python/hail/plot/plots.py
Expand Up @@ -58,7 +58,7 @@ def cdf(data, k=350, legend=None, title=None, normalize=True, log=False):
data : :class:`.Struct` or :class:`.Float64Expression`
Sequence of data to plot.
k : int
Accuracy parameter.
Accuracy parameter (passed to :func:`approx_cdf`).
legend : str
Label of data on the x-axis.
title : str
Expand Down