scipy-yli/docs/general.rst

30 lines
603 B
ReStructuredText
Raw Permalink Normal View History

2022-10-17 21:41:19 +11:00
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
2022-11-09 17:05:04 +11:00
.. autofunction:: yli.utils.check_nan
dtype conventions
-----------------
.. autofunction:: yli.as_ordinal
2022-10-17 21:41:19 +11:00
General result classes
----------------------
2022-11-09 22:10:15 +11:00
.. autoclass:: yli.utils.Estimate
2022-10-17 21:41:19 +11:00
:members:
2022-11-09 22:10:15 +11:00
.. autoclass:: yli.utils.Interval
2022-10-17 21:41:19 +11:00
:members: