scipy-yli/docs/general.rst
2022-11-09 17:39:52 +11:00

27 lines
669 B
ReStructuredText

General specifications
======================
.. _nan-handling:
NaN handling
------------
Most functions take a parameter **nan_policy** to specify how to handle *nan* values in the data. The options are:
* **warn** (default) – Warn on *nan* values
* **raise** – Raise an error on *nan* values
* **omit** – Silently drop rows with *nan* values
In determining whether there is *nan* in the data, only the columns specified in the function (if applicable) are considered.
.. autofunction:: yli.utils.check_nan
General result classes
----------------------
.. autoclass:: yli.utils.ConfidenceInterval
:members:
.. autoclass:: yli.utils.Estimate
:members: