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

===========
Data module
===========

.. automodule:: orgmatt.data
    :members:


Databases
=========

The following databases are present:

* :source:`orgmatt/data/excretions.csv`, quantities of urine and feces excreted
  daily for different age, sex, dietary groups, etc,
* :source:`orgmatt/data/excretion_content.csv`, information on the nutrient
  content for a volume of urine or a mass of feces,
* :source:`orgmatt/data/excretion_frequency.csv`, with information on the
  urination and defecation frequencies in individuals,
* :source:`orgmatt/data/food.csv`, containing the amounts of biodegradable
  matter generated per capita and their composition by kg of fresh matter,
* :source:`orgmatt/data/nutrients_flows_body.csv`, detailing nutrient flows
  in excreta or retained in the body of a person during a day,
* :source:`orgmatt/data/nutrients_intake.csv` on the average nutritional intake
  for people of various age, sex, and dietary groups,
* :source:`orgmatt/data/fertilizer_impact.csv` contains data on the
  environmental impacts of different types of fertilizers.
* :source:`orgmatt/data/fraction_nutrient_excreted.csv`, fraction of nutrient
  intake excreted in urine and feces as a function of age, sex, and diet.

Note that a description text for each database is also available in the data
folder.
These descriptions are reported below.


.. include:: ../../orgmatt/data/excretion_content.csv.description.rst

.. include:: ../../orgmatt/data/excretion_frequency.csv.description.rst

.. include:: ../../orgmatt/data/excretions.csv.description.rst

.. include:: ../../orgmatt/data/food.csv.description.rst

.. include:: ../../orgmatt/data/nutrients_intake.csv.description.rst

.. include:: ../../orgmatt/data/nutrients_flows_body.csv.description.rst

.. include:: ../../orgmatt/data/nutrient_intake_flow_fractions.csv.description.rst