Taxonomy Properties: Difference between revisions
 |
|||
(42 intermediate revisions by 2 users not shown) | |||
Line 10: | Line 10: | ||
* example: additives_classes:en: en:colour - the additive classes associated to E100 | * example: additives_classes:en: en:colour - the additive classes associated to E100 | ||
* usage: [[Additives taxonomy]] | * usage: [[Additives taxonomy]] | ||
==== | * Linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/additives_classes.txt | ||
 | |||
==== agribalyse_food_code ==== | |||
* example: agribalyse_food_code:en:3000 | * example: agribalyse_food_code:en:3000 | ||
* usage [[Categories taxonomy]] | * usage [[Categories taxonomy]], [[Minerals taxonomy]] | ||
==== agribalyse_proxy_food_code ==== | ==== agribalyse_proxy_food_code ==== | ||
Line 26: | Line 28: | ||
* example: allergens:en: en:milk | * example: allergens:en: en:milk | ||
* usage: [[Ingredients]] | * usage: [[Ingredients]] | ||
* linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/allergens.txt | |||
==== carbon_footprint_fr_foodges_ingredient ==== | ==== carbon_footprint_fr_foodges_ingredient ==== | ||
Line 69: | Line 72: | ||
A short description of a term. This is usually taken from a standard, wikidata, wiktionary or wikipedia. | A short description of a term. This is usually taken from a standard, wikidata, wiktionary or wikipedia. | ||
* example: description:en:Acids are substances which increase the acidity of a foodstuff and/or impart a sour taste to it. - which described the term Acid in the Additives Classes taxonomy. | * example: description:en:Acids are substances which increase the acidity of a foodstuff and/or impart a sour taste to it. - which described the term Acid in the Additives Classes taxonomy. | ||
* usage: [[Additives Classes taxonomy]], [[Categories taxonomy]], [[Improvements taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]] | * usage: [[Additives Classes taxonomy]], [[Categories taxonomy]], [[Improvements taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]], [[Nucleotides taxonomy]], [[Other nutritional substances taxonomy]], | ||
 | |||
==== dv_value ==== | |||
* example: dv_value:en: 40 | |||
* usage: [[Nutrients taxonomy]] | |||
 | |||
==== dv_2016_value ==== | |||
* example: dv_2016_value:en: 20 | |||
* usage: [[Nutrients taxonomy]] | |||
==== e_number ==== | ==== e_number ==== | ||
Line 112: | Line 123: | ||
* example: efsa_evaluation_url:en: http://dx.doi.org/10.2903/j.efsa.2010.1679 - to indicate the documentation for the term E100 Â | * example: efsa_evaluation_url:en: http://dx.doi.org/10.2903/j.efsa.2010.1679 - to indicate the documentation for the term E100 Â | ||
* usage: [[Additives taxonomy]] | * usage: [[Additives taxonomy]] | ||
==== evaluation ==== | |||
* example: evaluation:en: bad | |||
* usage [[Nutrients taxonomy]] | |||
==== expected_ingredients ==== | |||
* example: expected_ingredients:en: en:olive-oil | |||
* usage [[Categories taxonomy]] | |||
* comment:should refer to an existing ingredient | |||
==== expected_nutriscore_grade ==== | |||
* example: expected_nutriscore_grade:en: c | |||
* usage: [[Categories taxonomy]] | |||
* comment: to create a data quality error if the nutriscore was different | |||
==== from_palm_oil ==== | ==== from_palm_oil ==== | ||
Line 117: | Line 140: | ||
* example: from_palm_oil:en:maybe | * example: from_palm_oil:en:maybe | ||
* usage [[Additives classes]], [[Ingredients taxonomy]] | * usage [[Additives classes]], [[Ingredients taxonomy]] | ||
==== gpc_category_code ==== | |||
Refers to a category in the gpc (https://gpc-browser.gs1.org) | |||
* example: gpc_category_code:en:18015 | |||
* usage [[Categories taxonomy]] | |||
==== gpc_category_name ==== | |||
Refers to the english category name in the gpc (https://gpc-browser.gs1.org) | |||
* example: gpc_category_name:en:Tea - Liquid/Ready to Drink | |||
* usage [[Categories taxonomy]] | |||
==== gpc_category_description ==== | |||
To indicate whether the term is made from palm oil. Possible values are: no, maybe, yes. | |||
* example: gpc_category_description:en:Definition: Includes any products that can be described/observed as a ready to drink beverage made from the dried leaves of the tea plant, Camellia Sinensis. Includes self-heating products and teas from single tea types such as Assam and Ceylon, and those, which are blends of various teas. Products may also have added flavourings such as lemon and milk or sweeteners. Definition Excludes: Excludes products such as Tea Bags or Loose Tea, Liquid Not Ready to Drink Teas, Teas in Capsules or Pods and Herbal Infusions/Tisanes. | |||
* usage [[Categories taxonomy]] | |||
==== image ==== | |||
This allows to add an image/logo related to the term. | |||
==== | ==== iu_value ==== | ||
example: iu_value:en: 0.025 | |||
usage: [[Nutrients taxonomy]] | |||
==== language_code_2 ==== | ==== language_code_2 ==== | ||
Line 139: | Line 178: | ||
* example: mandatory_additive_class:en: en:colour | * example: mandatory_additive_class:en: en:colour | ||
* usage: [[Additives taxonomy]] | * usage: [[Additives taxonomy]] | ||
* Linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/additives_classes.txt | |||
==== non_recyclable_and_non_biodegradable ==== | |||
Values: no, maybe, yes | |||
example: non_recyclable_and_non_biodegradable:en:maybe | |||
usage: [[Packaging materials taxonomy]] | |||
==== nova ==== | ==== nova ==== | ||
Line 144: | Line 189: | ||
* example: nova:en:3 | * example: nova:en:3 | ||
* usage: [[Additive classes taxonomy]], [[Categories taxonomy]] | * usage: [[Additive classes taxonomy]], [[Categories taxonomy]] | ||
* Linked Taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/nova_groups.txt | |||
==== opposite ==== | ==== opposite ==== | ||
Line 154: | Line 200: | ||
* example: origins:en: en:Finland | * example: origins:en: en:Finland | ||
* usage: [[Categories taxonomy]] | * usage: [[Categories taxonomy]] | ||
* Linked Taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/origins.txt | |||
==== pnns_group_2 ==== | ==== pnns_group_2 ==== | ||
Line 167: | Line 214: | ||
* example: protected_name_type:en: tsg | * example: protected_name_type:en: tsg | ||
* usage: [[Categories taxonomy]] | * usage: [[Categories taxonomy]] | ||
==== recycling_code ==== | |||
Values: 1 | |||
* example: recycling_code:en:1 | |||
* usage: [[Packaging materials taxonomy]] | |||
==== show_ingredients ==== | ==== show_ingredients ==== | ||
Line 177: | Line 228: | ||
* example: show_on_producers_platform:en:yes | * example: show_on_producers_platform:en:yes | ||
* usage: [[Data quality taxonomy]] | * usage: [[Data quality taxonomy]] | ||
==== unit ==== | |||
Default unit to be used. Possible values: g, mg, ”g, kj, kcal, %DV. | |||
* example: unit:en: kj | |||
* usage: [[Nutrients taxonomy]] | |||
==== unit_ca ==== | |||
Default units to be used in Canada. Possible values: g, mg, ”g, kj, kcal, %DV. | |||
* example: unit_ca:en: kcal | |||
* usage: [[Nutrients taxonomy]] | |||
==== unit_us ==== | |||
Default units to be used in the USA, Possible values: g, mg, ”g, kj, kcal, %DV. | |||
* example: unit_us:en: kcal | |||
* usage: [[Nutrients taxonomy]] | |||
==== vegan ==== | ==== vegan ==== | ||
Indicates whether the associated term is usable for a vegan diet. Values are: no, maybe, yes. | Indicates whether the associated term is usable for a vegan diet. Values are: no, maybe, yes. | ||
* example: vegan:en:yes | * example: vegan:en:yes | ||
* usage: [[Additives taxonomy]], [[Ingredients taxonomy]] | * usage: [[Additives taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]], [[Nucleotides taxonomy]], [[Other nutritional substances taxonomy]], | ||
==== vegetarian ==== | ==== vegetarian ==== | ||
Indicates whether the associated term is usable for a vegetarian diet. Values are: no, maybe, yes. | Indicates whether the associated term is usable for a vegetarian diet. Values are: no, maybe, yes. | ||
* example: vegetarian:en:maybe | * example: vegetarian:en:maybe | ||
* usage: [[Additives taxonomy]], [[Ingredients taxonomy]] | * usage: [[Additives taxonomy]], [[Ingredients taxonomy]], [[Minerals taxonomy]], [[Nucleotides taxonomy]], [[Other nutritional substances taxonomy]] | ||
==== who_id ==== | |||
Maps to a world health organisation id? | |||
* example: who_id:en:7 | |||
* usage: [[Categories taxonomy]] | |||
==== wikidata ==== | ==== wikidata ==== | ||
A reference to the corresponding entry on [https://www.wikidata.org/ Wikidata]. | A reference to the corresponding entry on [https://www.wikidata.org/ Wikidata]. | ||
* Example: wikidata:en:Q5111 | * Example: wikidata:en:Q5111 | ||
* Usage: [[Additives taxonomy]]. [[Allergens taxonomy]], [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]], [[Languages taxonomy]] | * Usage: [[Additives taxonomy]]. [[Allergens taxonomy]], [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]], [[Languages taxonomy]], [[Nucleotides taxonomy]], [[Nutrients taxonomy]], [[Origins taxonomy]], [[Other nutritional substances taxonomy]], [[Packaging materials taxonomy]], [[Packaging shapes taxonomy]], [[Vitamins taxonomy]] | ||
==== wikipedia ==== | ==== wikipedia ==== | ||
A link the term with its equivalent on Wikipedia. | A link the term with its equivalent on Wikipedia. | ||
* example: wikipedia:en:https://en.wikipedia.org/wiki/Glutamine | * example: wikipedia:en:https://en.wikipedia.org/wiki/Glutamine | ||
* usage: [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]] | * usage: [[Amino acids taxonomy]], [[Categories taxonomy]], [[Ingredients taxonomy]], [[Nucleotides taxonomy]], [[Nutrients taxonomy]], [[Other nutritional substances taxonomy]], [[Vitamins taxonomy]] | ||
== Properties suggested == | == Properties suggested == | ||
Line 203: | Line 273: | ||
Instructions for editors. | Instructions for editors. | ||
* Example: comment:en:do not mix with packaging gas. - to indicate that two terms should not be mixed up. | * Example: comment:en:do not mix with packaging gas. - to indicate that two terms should not be mixed up. | ||
* Usage: [[Additives classes taxonomy]] | * Usage: [[Additives classes taxonomy]], [[Minerals taxonomy]] | ||
==== category ==== | ==== category ==== |
Latest revision as of 09:32, 9 November 2023
Introduction
Taxonomy properties describe possible properties that can be added to a term in any Taxonomy.
This document gives an alphabetic overview of all (I hope) properties that are in use in all taxonomies. Not every property is relevant to every taxonomy.
Properties in use
additives_classes
The additive classes associated to a term.
- example: additives_classes:en: en:colour - the additive classes associated to E100
- usage: Additives taxonomy
- Linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/additives_classes.txt
agribalyse_food_code
- example: agribalyse_food_code:en:3000
- usage Categories taxonomy, Minerals taxonomy
agribalyse_proxy_food_code
- example: agribalyse_proxy_food_code:en:19013
- usage: Categories taxonomy
agribalyse_proxy_food_name
- example: agribalyse_proxy_food_name:en:Beer, dark
- usage: Categories taxonomy
allergens
To indicate what allergen the term belongs to.
- example: allergens:en: en:milk
- usage: Ingredients
- linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/allergens.txt
carbon_footprint_fr_foodges_ingredient
carbon_footprint_fr_foodges_ingredient:fr:Lait semi-écrémé, pasteurisé
- usage: Ingredients taxonomy
carbon_footprint_fr_foodges_value
- example: carbon_footprint_fr_foodges_value:fr:1.2
- usage: Ingredients taxonomy
ciqual_food_code
The ciqual code
- example: ciqual_food_code:en:13165
- usage: Categories taxonomy, Ingredients taxonomy
ciqual_food_name
The Ciqual description.
- example: ciqual_food_name:fr:Dessert lacté infantile au riz ou à la semoule
- usage: Categories taxonomy, Ingredients taxonomy
ciqual_proxy_food_code
- example: ciqual_proxy_food_code:en:18340
- usage: Categories taxonomy
ciqual_proxy_food_name
- example: ciqual_proxy_food_name:en:Fruit soft drink, carbonated (less than 10% of fruit juice), without sugar and with artificial sweetener(s)
- usage: Categories taxonomy
country_code_2
The two letter country code for a country. This is based on the standard ISO 3166 alpha 2 .
- example: country_code_2:en:AF - the country code for Afghanistan.
colour_index
- example: colour_index:en:CI 19140
- usage: Additives taxonomy
country_code_3
The three letter country code for a country. This is based on the standard ISO 3166 alpha 3
- example: country_code_2:en:AFG - the country code for Afghanistan.
- usage: Countries taxonomy
description
A short description of a term. This is usually taken from a standard, wikidata, wiktionary or wikipedia.
- example: description:en:Acids are substances which increase the acidity of a foodstuff and/or impart a sour taste to it. - which described the term Acid in the Additives Classes taxonomy.
- usage: Additives Classes taxonomy, Categories taxonomy, Improvements taxonomy, Ingredients taxonomy, Minerals taxonomy, Nucleotides taxonomy, Other nutritional substances taxonomy,
dv_value
- example: dv_value:en: 40
- usage: Nutrients taxonomy
dv_2016_value
- example: dv_2016_value:en: 20
- usage: Nutrients taxonomy
e_number
A reference url to a report? The European standard identification for additives that corresponds to the term.
- example: e_number:en:100 - to associate the term with E100
- usage: Additives taxonomy
efsa
References to efsa documents. There can be more that one per term.
- example: efsa:en:http://www.efsa.europa.eu/fr/efsajournal/doc/1331.pdf reference to a report on E102
- usage: Additives taxonomy
efsa_evaluation
The title of European Food Safety Authority evaluation report of the term.
- example: efsa_evaluation:en: Scientific Opinion on the re-evaluation of curcumin (E 100) as a food additive
- usage: Additives taxonomy
efsa_evaluation_adi_established
- example: efsa_evaluation_adi_established:en: en:no
- usage: Additives taxonomy
efsa_evaluation_date
The European standard identification for additives that corresponds to the term.
- example: efsa_evaluation_date:en: 2010-09-06 - the latest evaluation date of the report on E100
- usage: Additives taxonomy
efsa_evaluation_exposure_mean_greater_than_adi
- example: efsa_evaluation_exposure_mean_greater_than_adi:en: en:no-group
- usage: Additives taxonomy
efsa_evaluation_exposure_95th_greater_than_adi
- example: efsa_evaluation_exposure_95th_greater_than_adi:en: en:adults, en:elderly, en:children, en:toddlers
- usage: Additives taxonomy
efsa_evaluation_overexposure_risk
- example: efsa_evaluation_overexposure_risk:en: en:moderate
- usage: Additives taxonomy
efsa_evaluation_url
A web-link to the European Food Safety Authority evaluation data for a term.
- example: efsa_evaluation_url:en: http://dx.doi.org/10.2903/j.efsa.2010.1679 - to indicate the documentation for the term E100
- usage: Additives taxonomy
evaluation
- example: evaluation:en: bad
- usage Nutrients taxonomy
expected_ingredients
- example: expected_ingredients:en: en:olive-oil
- usage Categories taxonomy
- comment:should refer to an existing ingredient
expected_nutriscore_grade
- example: expected_nutriscore_grade:en: c
- usage: Categories taxonomy
- comment: to create a data quality error if the nutriscore was different
from_palm_oil
To indicate whether the term is made from palm oil. Possible values are: no, maybe, yes.
- example: from_palm_oil:en:maybe
- usage Additives classes, Ingredients taxonomy
gpc_category_code
Refers to a category in the gpc (https://gpc-browser.gs1.org)
- example: gpc_category_code:en:18015
- usage Categories taxonomy
gpc_category_name
Refers to the english category name in the gpc (https://gpc-browser.gs1.org)
- example: gpc_category_name:en:Tea - Liquid/Ready to Drink
- usage Categories taxonomy
gpc_category_description
To indicate whether the term is made from palm oil. Possible values are: no, maybe, yes.
- example: gpc_category_description:en:Definition: Includes any products that can be described/observed as a ready to drink beverage made from the dried leaves of the tea plant, Camellia Sinensis. Includes self-heating products and teas from single tea types such as Assam and Ceylon, and those, which are blends of various teas. Products may also have added flavourings such as lemon and milk or sweeteners. Definition Excludes: Excludes products such as Tea Bags or Loose Tea, Liquid Not Ready to Drink Teas, Teas in Capsules or Pods and Herbal Infusions/Tisanes.
- usage Categories taxonomy
image
This allows to add an image/logo related to the term.
iu_value
example: iu_value:en: 0.025 usage: Nutrients taxonomy
language_code_2
The two letter language code as defined by the ISO standard ISO 639-1.
- example: language_code_2:en:ab
- usage: Languages taxonomy
language_codes
A list of two letter language codes. This can be used to list the languages spoken in a country
- Example: language_codes:en:ps,prs - the languages spoken in Afghanistan
- Usage: Countries taxonomy
language_code_3
The three letter language code as defined by the ISO standard ISO 639-2.
- example: language_code_3:en:abk
- usage: Languages taxonomy
mandatory_additive_class
- example: mandatory_additive_class:en: en:colour
- usage: Additives taxonomy
- Linked taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/additives_classes.txt
non_recyclable_and_non_biodegradable
Values: no, maybe, yes example: non_recyclable_and_non_biodegradable:en:maybe usage: Packaging materials taxonomy
nova
The NOVA level. Values can be 1,2,3,4.
- example: nova:en:3
- usage: Additive classes taxonomy, Categories taxonomy
- Linked Taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/nova_groups.txt
opposite
To specify the opposite relation to another term, i.e. organic versus non-organic;
- example:
- usage: [Labels taxonomy]]
origins
To indicate the geographic origin. A comma separated list of values, keys (language code + canonical value) from the Countries taxonomy.
- example: origins:en: en:Finland
- usage: Categories taxonomy
- Linked Taxonomy: https://github.com/openfoodfacts/openfoodfacts-server/blob/main/taxonomies/origins.txt
pnns_group_2
- example: pnns_group_2:en:Artificially sweetened beverages
- usage: Categories taxonomy
protected_name_file_number
- example: protected_name_file_number:en: TSG-FI-0014
- usage: Categories taxonomy
protected_name_type
Valid values gi, tsg
- example: protected_name_type:en: tsg
- usage: Categories taxonomy
recycling_code
Values: 1
- example: recycling_code:en:1
- usage: Packaging materials taxonomy
show_ingredients
Values vegetarian:maybe, vegetarian:no, vegan:maybe, vegan:no, from_palm_oil:maybe, from_palm_oil:yes
- example: show_ingredients:en:vegetarian:maybe
- usage: Ingredients analysis taxonomy
show_on_producers_platform
Values no, yes.
- example: show_on_producers_platform:en:yes
- usage: Data quality taxonomy
unit
Default unit to be used. Possible values: g, mg, ”g, kj, kcal, %DV.
- example: unit:en: kj
- usage: Nutrients taxonomy
unit_ca
Default units to be used in Canada. Possible values: g, mg, ”g, kj, kcal, %DV.
- example: unit_ca:en: kcal
- usage: Nutrients taxonomy
unit_us
Default units to be used in the USA, Possible values: g, mg, ”g, kj, kcal, %DV.
- example: unit_us:en: kcal
- usage: Nutrients taxonomy
vegan
Indicates whether the associated term is usable for a vegan diet. Values are: no, maybe, yes.
- example: vegan:en:yes
- usage: Additives taxonomy, Ingredients taxonomy, Minerals taxonomy, Nucleotides taxonomy, Other nutritional substances taxonomy,
vegetarian
Indicates whether the associated term is usable for a vegetarian diet. Values are: no, maybe, yes.
- example: vegetarian:en:maybe
- usage: Additives taxonomy, Ingredients taxonomy, Minerals taxonomy, Nucleotides taxonomy, Other nutritional substances taxonomy
who_id
Maps to a world health organisation id?
- example: who_id:en:7
- usage: Categories taxonomy
wikidata
A reference to the corresponding entry on Wikidata.
- Example: wikidata:en:Q5111
- Usage: Additives taxonomy. Allergens taxonomy, Amino acids taxonomy, Categories taxonomy, Ingredients taxonomy, Languages taxonomy, Nucleotides taxonomy, Nutrients taxonomy, Origins taxonomy, Other nutritional substances taxonomy, Packaging materials taxonomy, Packaging shapes taxonomy, Vitamins taxonomy
wikipedia
A link the term with its equivalent on Wikipedia.
- example: wikipedia:en:https://en.wikipedia.org/wiki/Glutamine
- usage: Amino acids taxonomy, Categories taxonomy, Ingredients taxonomy, Nucleotides taxonomy, Nutrients taxonomy, Other nutritional substances taxonomy, Vitamins taxonomy
Properties suggested
Some properties have been suggestion and are often commented out in the taxonomies.
comment
Instructions for editors.
- Example: comment:en:do not mix with packaging gas. - to indicate that two terms should not be mixed up.
- Usage: Additives classes taxonomy, Minerals taxonomy
category
To indicate the corresponding category
- usage: Ingredients taxonomy
origin
- origin:en:pork:maybe
- usage: Additives taxonomy
usage
An example of how the term is on packages.
- example: usage:en: acerola powder with cassava starch (cooking enhancer) - to illustrate the usage of the term cooking enhancer.
- usage: Additives classes taxonomy