Data module#

This module imports all databases used in the package.

These databases contain consolidated data from the literature about the amount of organic matter generated by various actors and the chemical composition of these resources.

Functions#

orgmatt.data.data_information(entry: str) str[source]#

Get additional information about the data and database entries:

  • compound name and details about its properties or definition

  • accronyms

  • impact types

  • units

orgmatt.data.get_dataset(name: str) DataFrame[source]#

Return the dataset associated to name as a DataFrame.

orgmatt.data.list_datasets() list[str][source]#

Return the list of available datasets.

Databases#

The following databases are present:

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

Excretion content#

The excretion_content.csv database contains information about the average content of urine and feces.

Description of the colums and their content

  • “compound” describes the chemical component:
    • “C”, carbon

    • “Ca”, calcium

    • “H2O”, water

    • “K”, potassium

    • “Mg”, magnesium

    • “N”, nitrogen

    • “P”, phosphorus

  • “excreta” in which the compound content was measured, among:
    • “feces (dry)”,

    • “feces (wet)”,

    • “stored urine”

    • “urine” (fresh)

  • “content”, the amount of “compound” present in a certain volume or mass of “excreta”

  • “std” gives the standard deviation associated to “content”

  • “min_content” gives lower-bound for a confidence interval (specified in “remark”)

  • “max_content” gives the upper-bound for a confidence interval (specified in “remark”)

  • “unit” (always “percent”, here)

  • “diet” specifies the diet of the individuals (omnivorous, vegetarian, vegan)

  • “group” specifies the age group of the individuals:
    • “infant” if less than 1 year old

    • “toddler”, between 1 and 3 included

    • “kid”, between 4 and 9 included

    • “teenager”, between 10 and 17 included

    • “young”, between 18 and 25 included

    • “adult”, between 26 and 64 included

    • “senior”, for 65 and above

  • “age” gives a more precise age range, with two main formats:
    • “< X” for all ages below X

    • “X-Y”, for all years between X and Y included

    • “> X” for all ages above X

  • “daytime”, the time at which the “excreta” analysed was generated, among “mixed”, “morning”, and “midday”

  • “individuals”, the number of people studied for the measurement

  • “country” specifies the country in which the ressource was generated/measured (alpha-3 ISO 3166 notation)

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • East Asia

    • Europe

    • Middle East

    • North America

    • Oceania

    • South America

    • South Asia

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data

Excretion frequency#

The excretion_frequency.csv database contains information about average urination and defecation frequencies in a day.

Description of the colums and their content

  • “type” is either “urination” or “defecation”

  • “frequency” gives the mean number of occurences per day

  • “std” gives the standard deviation associated to “value”

  • “min_freq” gives lower-bound for a confidence interval (specified in “remark”)

  • “max_freq” gives the upper-bound for a confidence interval (specified in “remark”)

  • “unit” (always “percent”, here)

  • “diet” specifies the diet of the individuals (omnivorous, vegetarian, vegan)

  • “group” specifies the age group of the individuals:
    • “infant” if less than 1 year old

    • “toddler”, between 1 and 3 included

    • “kid”, between 4 and 9 included

    • “teenager”, between 10 and 17 included

    • “young”, between 18 and 25 included

    • “adult”, between 26 and 64 included

    • “senior”, for 65 and above

  • “age” gives a more precise age range, with two main formats:
    • “< X” for all ages below X

    • “X-Y”, for all years between X and Y included

    • “> X” for all ages above X

  • “sex”, the biological sex of the individuals (“mixed”, “female”, “male”)

  • “individuals”, the number of people studied for the measurement

  • “country” specifies the country in which the ressource was generated/measured (alpha-3 ISO 3166 notation)

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • East Asia

    • Europe

    • Middle East

    • North America

    • Oceania

    • South America

    • South Asia

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data

Excretions#

The excretions.csv database contains information about the daily amounts of urine and feces excreted per capita.

Description of the colums and their content

  • “excreta” describes the type of excretion:
    • “urine”

    • “feces (wet)”, for fresh feces with large water content

    • “feces (dry)”, for the dry solid content of feces

  • “amount” gives the mean (if available) or median (otherwise) of the excreted amount

  • “std” gives the standard deviation associated to “value”

  • “min_amount” gives lower-bound for a confidence interval (specified in “remark”)

  • “max_amount” gives the upper-bound for a confidence interval (specified in “remark”)

  • “unit” (always “percent”, here)

  • “diet” specifies the diet of the individuals (omnivorous, vegetarian, vegan)

  • “group” specifies the age group of the individuals:
    • “infant” if less than 1 year old

    • “toddler”, between 1 and 3 included

    • “kid”, between 4 and 9 included

    • “teenager”, between 10 and 17 included

    • “young”, between 18 and 25 included

    • “adult”, between 26 and 64 included

    • “senior”, for 65 and above

  • “age” gives a more precise age range, with two main formats:
    • “< X” for all ages below X

    • “X-Y”, for all years between X and Y included

    • “> X” for all ages above X

  • “sex”, the biological sex of the individuals (“mixed”, “female”, “male”)

  • “individuals”, the number of people studied for the measurement

  • “country” specifies the country in which the ressource was generated/measured (alpha-3 ISO 3166 notation)

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • East Asia

    • Europe

    • Middle East

    • North America

    • Oceania

    • South America

    • South Asia

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data

Food#

The food.csv database contains information about biowaste and food related resources.

Description of the colums and their content

  • “property” describes what type of measure is provided, among:
    • “generation”, the amount of ressource (specified in the “type” column) that is produced per capita

    • “H2O”, the water content

    • “TOC”, the total organic carbon content

    • “CNR”, the carbon/nitrogen ratio

    • “N”, the nitrogen content

    • “P”, the phosphorus content

    • “K”, the potassium content

  • “type” specifies what type of ressource is considered

  • “value” gives the mean (if available) or median (otherwise) of the measure

  • “std” gives the standard deviation associated to “value”

  • “min” gives the minimum measured value or lower-bound for the confidence interval (specified in “remark”)

  • “max” gives the maximum measured value or the upper-bound for the confidence interval (specified in “remark”)

  • “unit” gives the unit “value” is expressed in

  • “country” specifies the country in which the ressource was generated/measured

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • Asia

    • Europe

    • North America

    • Oceania

    • South America

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data

Nutrients intake#

The nutrients_intake.csv database contains information on the average daily nutritional intake per capita.

Description of the colums and their content

  • “compound” describes the nutrient type:
    • “Ca”, calcium

    • “K”, potassium

    • “Mg”, magnesium

    • “P”, phosphorus

    • “protein”

  • “intake” gives the mean (if available) or median (otherwise) intake of “compound” per capita and day

  • “min_intake” gives the minimum measured value or lower-bound for the confidence interval (specified in “remark”)

  • “max_intake” gives the maximum measured value or the upper-bound for the confidence interval (specified in “remark”)

  • “unit” gives the unit “value” is expressed in

  • “diet” specifies the diet of the individuals (omnivorous, vegetarian, vegan)

  • “group” specifies the age group of the individuals:
    • “infant” if less than 1 year old

    • “toddler”, between 1 and 3 included

    • “kid”, between 4 and 9 included

    • “teenager”, between 10 and 17 included

    • “young”, between 18 and 25 included

    • “adult”, between 26 and 64 included

    • “senior”, for 65 and above

  • “ethnicity” of the individuals

  • “age” gives a more precise age range, with two main formats:
    • “< X” for all ages below X

    • “X-Y”, for all years between X and Y included

    • “> X” for all ages above X

  • “sex”, the biological sex of the individuals (“mixed”, “female”, “male”)

  • “individuals”, the number of people studied for the measurement

  • “country” specifies the country in which the ressource was generated/measured (alpha-3 ISO 3166 notation)

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • East Asia

    • Europe

    • Middle East

    • North America

    • Oceania

    • South America

    • South Asia

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data

Bodily nutrient flows#

The nutrients_flows_body.csv database contains information about nutrients flows in and out of the body. These flows are associated to food intake, retention due to growth (positive) or aging (negative), and excretion (urine and feces).

Description of the colums and their content

  • “compound” describes the nutrient type:
    • “Ca”, calcium

    • “K”, potassium

    • “Mg”, magnesium

    • “N”, nitrogen

    • “Na”, sodium

    • “P”, phosphorus

    • “protein”

    • “S”, sulfur

  • “flow” specifies the type flow that is considered, amoung:
    • “intake”, nutrients entering the body via food ingestion

    • “retention”, nutrients staying within the body due to growth (if positive) or leaving the body due to bone or muscle loss (if negative, from aging mechanisms)

    • “urine”

    • “feces”

  • “amount” gives the mean (if available) or median (otherwise) of the measure

  • “std” gives the standard deviation associated to “value”

  • “min_amount” gives the minimum measured value or lower-bound for the confidence interval (specified in “remark”)

  • “max_amount” gives the maximum measured value or the upper-bound for the confidence interval (specified in “remark”)

  • “unit” gives the unit associated to “amount”

  • “diet” specifies the diet of the individuals (omnivorous, vegetarian, vegan)

  • “group” specifies the age group of the individuals:
    • “infant” if less than 1 year old

    • “toddler”, between 1 and 3 included

    • “kid”, between 4 and 9 included

    • “teenager”, between 10 and 17 included

    • “young”, between 18 and 25 included

    • “adult”, between 26 and 64 included

    • “senior”, for 65 and above

  • “age” gives a more precise age range, with two main formats:
    • “< X” for all ages below X

    • “X-Y”, for all years between X and Y included

    • “> X” for all ages above X

  • “sex”, the biological sex of the individuals (“mixed”, “female”, “male”)

  • “individuals”, the number of people studied for the measurement

  • “country” specifies the country in which the ressource was generated/measured (alpha-3 ISO 3166 notation)

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • East Asia

    • Europe

    • Middle East

    • North America

    • Oceania

    • South America

    • South Asia

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data

Fractions of nutrient intake going into various bodily flows#

The nutrient_intake_flow_fractions.csv database contains information about the fraction of the nutrient intake from food that goes into various flows. These flows are associated to food intake, retention due to growth (positive) or aging (negative), and excretion (urine and feces).

Description of the colums and their content

  • “compound” describes the nutrient type:
    • “Ca”, calcium

    • “K”, potassium

    • “Mg”, magnesium

    • “N”, nitrogen

    • “P”, phosphorus

  • “flow” specifies the type flow that is considered, amoung:
    • “retention”, nutrients staying within the body due to growth (if positive) or leaving the body due to bone or muscle loss (if negative, from aging mechanisms)

    • “urine”

    • “feces”

  • “fraction” gives the mean (if available) or median (otherwise) fraction of the intake that goes into that flow

  • “std” gives the standard deviation associated to “value”

  • “min_frac” gives lower-bound for a confidence interval (specified in “remark”)

  • “max_frac” gives the upper-bound for a confidence interval (specified in “remark”)

  • “unit” (always “percent”, here)

  • “diet” specifies the diet of the individuals (omnivorous, vegetarian, vegan)

  • “group” specifies the age group of the individuals:
    • “infant” if less than 1 year old

    • “toddler”, between 1 and 3 included

    • “kid”, between 4 and 9 included

    • “teenager”, between 10 and 17 included

    • “young”, between 18 and 25 included

    • “adult”, between 26 and 64 included

    • “senior”, for 65 and above

  • “age” gives a more precise age range, with two main formats:
    • “< X” for all ages below X

    • “X-Y”, for all years between X and Y included

    • “> X” for all ages above X

  • “sex”, the biological sex of the individuals (“mixed”, “female”, “male”)

  • “individuals”, the number of people studied for the measurement

  • “country” specifies the country in which the ressource was generated/measured (alpha-3 ISO 3166 notation)

  • “region” specifies the world region in which the ressource was generated/measured, among:
    • Africa

    • East Asia

    • Europe

    • Middle East

    • North America

    • Oceania

    • South America

    • South Asia

  • “date” specifies the date at which the data was collected

  • “source” gives a human-readable name for the source

  • “identifier” gives a unique identifier linking to the source

  • “idtype” specifies the type of the identifier, among:
    • DOI

    • ISBN

    • PMID

    • URL

  • “remark” provides additional information about the data