..
    SPDX-FileCopyrightText: 2022 Tanguy Fardet
    SPDX-License-Identifier: CC-BY-SA-4.0
    docs/modules/metabolism.rst.in

=================
Metabolism module
=================

.. automodule:: orgmatt.metabolism
    :noindex:


Age and gender
==============

Metabolic data can be provided for different age groups and genders.
Genders are "male", "female", or "mixed".

Age groups are separated as follow:

* infants, less than 1 year-old ("< 1"),
* toddlers, less than 4 year-old ("1-3"),
* kids, up to 10 year-old ("4-10"),
* teenagers ("11-17"),
* adults ("18-64"), among which young adults ("18-24"),
* seniors, above 65 (">= 65").

For age ranges that overlap several groups, the group with the largest overlap
will be chosen.


Content
=======

.. module:: orgmatt.metabolism

.. autosummary::

    DataBasedMetabolicModel
    Diet
    ReferenceHumanMetabolism
    body_composition
    fraction_nutrient_excreta
    fraction_nutrient_retention
    get_diet
    intake_fraction_age


Details
=======


.. autoclass:: DataBasedMetabolicModel
    :members:

.. autoclass:: Diet
    :members:

.. autoclass:: ReferenceHumanMetabolism
    :members:

.. autofunction:: body_composition

.. autofunction:: fraction_nutrient_excreta

.. autofunction:: fraction_nutrient_retention

.. autofunction:: get_diet

.. autofunction:: intake_fraction_age