scipy-yli/docs/general.rst

30 lines
603 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
.. autofunction:: yli.utils.check_nan
dtype conventions
-----------------
.. autofunction:: yli.as_ordinal
General result classes
----------------------
.. autoclass:: yli.utils.Estimate
:members:
.. autoclass:: yli.utils.Interval
:members: