scipy-yli/docs/internal.rst

44 lines
889 B
ReStructuredText

Internal utilities
==================
Data wrangling
--------------
.. autofunction:: yli.utils.as_2groups
.. autofunction:: yli.utils.convert_pandas_nullable
*p* values
----------
.. autofunction:: yli.utils.fmt_p
.. autoclass:: yli.utils.PValueStyle
.. attribute:: VALUE_ONLY
Display only the *p* value (e.g. ``0.08``, ``<0.001*``)
This is an alias for specifying no flags.
.. attribute:: RELATION
Force displaying a relational operator before the *p* value (e.g. ``= 0.08``, ``< 0.001*``)
.. attribute:: TABULAR
Pad with spaces to ensure decimal points align (incompatible with :attr:`RELATION`)
.. attribute:: HTML
Format as HTML (i.e. escape ``<``)
Formula manipulation
--------------------
.. autofunction:: yli.utils.cols_for_formula
.. autofunction:: yli.utils.formula_factor_ref_category
.. autofunction:: yli.utils.parse_patsy_term