Skip to content

Commit

Permalink
Merge pull request #136 from paulsengroup/docs/stats
Browse files Browse the repository at this point in the history
Update the Quickstart section to showcase PixelSelector.describe()
  • Loading branch information
robomics authored Nov 30, 2024
2 parents 353d55b + a53cbc1 commit 4139ef2
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,25 @@ Fetching balancing weights:
13757 NaN 0.069841 0.111556
[13758 rows x 3 columns]
Efficiently compute descriptive statistics
------------------------------------------

hictkpy supports computing common descriptive statistics without reading interactions into memory (and without traversing the data more than once).

Compute all supported statistics at once:

.. code-block:: ipythonconsole
In [26]: f.fetch().describe()
Out[26]:
{'nnz': 18122793,
'sum': 114355295,
'min': 1,
'max': 53908,
'mean': 6.310025998751958,
'variance': 9918.666837525623,
'skewness': 83.28386530442891,
'kurtosis': 20043.612488253475}
For more details, please refer to the **Statistics** section of the API docs for the :py:class:`hictkpy.PixelSelector` class.

0 comments on commit 4139ef2

Please sign in to comment.