micronutrientsupport / database-architecture

The Postgres database code for the MAPS tool
3 stars 0 forks source link

User-facing info about Food Composition table metadata #138

Open rbroth opened 3 years ago

rbroth commented 3 years ago

What metadata do we want to display to the end-user about a Food Composition Table dataset?

LouiseAnder commented 3 years ago

thanks @rbroth can we add DOI as well, even if N/A for many/some of these?

LuciaSegovia commented 3 years ago

Hi both!

This was my template to extract info from FCTs, so it's already done for the 13 FCTs that we identified to be used in MAPS back in June last year, but it might be too much info for our standard data extraction :) . Let me know what you think!

Variable_Name Variables_Description
Name Name with description of the FCT (including version and/or year of publication) (as per in FAO/INFOODS website)
Short_name Name of the food composition
Authors Name of the authors
Country/Region Country or region intended use. Countries ISO 3166-1 alpha-3
LeadOrganization Name of the organization(s) responsible
Year Year of publication
Language Language(s) of the FCT
DataFormat Primary data type in which the information is provided (xlxs, pdf, csv )
Documentation Information about the data, within the dataset or as user guide, manuscript, etc. (yes or no)
DocumentationLink link to the data and/or metadata
Licence Type of licence (i.e. CC, propietary, etc.)
DataSources Source of data, i.e. other food composition tables, analyzed, etc. with number (n) or perc. (%) if available
FoodCategories Number of food categories
CategoryList List of the food categories
FoodItems Number of food items
Component Number of nutrient and other components reported
ComponentList List of nutrient and other components reported
EDIBLE This variable contains information on the reporting of edible portion. Values can be reported as EDIBLE, REFUSE, INEDIBLE or NONE (no reported); Edible coefficient = "from whole to fillet/flesh"(EDIBLE1);  'from purchased to portion as consumed' (EDIBLE2)
ENERC_cal Analysis or method used to calculate total energy
PROT_cal Analysis or method used to calculate protein
CHO_cal Analysis or method used to calculate carbohydrates
FIBT_cal Analysis or method used to calculate fibre
FOLDFE_cal Analysis or method used to calculate folate (dietary folate eq.)
FOL_cal Analysis or method used to calculate folate (total)
VITB12_cal Analysis or method used to calculate vitamin B12
VITA_cal Analysis or method used to calculate vitamin A as, retinol eq.[VITA] and/ or retinol active eq. [VITA_REA]
CARTB_cal Analysis or method used to calculate beta-carotene [CARTB] and beta-carotene equivalent [CARTBEQ]
VITC_cal Analysis or method used to calculate vitamin C
ID_cal Analysis or method used to calculate iodine
ZN_cal Analysis or method used to calculate zinc
SE_cal Analysis or method used to calculate selenium (total, organic and inorganic)
FE_cal Analysis or method used to calculate iron
CA_cal Analysis or method used to calculate calcium
PHYTAC_cal Analysis or method used to calculate phytate (total), phytic acid or Inositol phosphate 2-6
EDIBLE_source If edible portion is repoted, source of the data
YF If yield factor is reported (yes or no)
YF_source If yield factor is repoted, source of the data
RF If retention factor is reported (yes or no)
RF_source If retention factor is repoted, source of the data
Recipes How the recipes were calculated: Ingredient method (i); Recipe method (recipe); Mixed method (m);  Raw ingredient method (r); Raw ingrediente corrected by weigh method (r-w); none
LouiseAnder commented 3 years ago

thanks @LuciaSegovia ! To me this looks like really good FCT metadata recording and will do a lot to support understanding of the outputs (e.g. the methods used). The licence information is a really valuable point too :)

LuciaSegovia commented 3 years ago

Thanks @LouiseAnder ! Then, if @rbroth has no objections, I would update the list of nutrients to be the same as in FCT :)

rbroth commented 3 years ago

Yes, that sounds good. I'll put in an issue to update the fct_source table with the extra columns (after you've changed the names)

See issue #141

LuciaSegovia commented 3 years ago

Hi @rbroth, do you want the nutrient variables as fibre_in_g or as fibre_cal ?

rbroth commented 3 years ago

Hi @rbroth, do you want the nutrient variables as fibre_in_g or as fibre_cal ?

The headings should match the headings agreed on in #77. Otherwise @spenny-liam would have to write extra code to import either naming scheme. So fibre_in_g please :)

LuciaSegovia commented 3 years ago

Cool. So, it would be like this...If you want, I can add the csv to teams :)

Variable_Name Variables_Description
fct_name Name with description of the FCT (including version and/or year of publication) (as per in FAO/INFOODS website)
fct_short_name Name of the food composition
fct_authors Name of the authors
fct_region Country or region intended use. Countries ISO 3166-1 alpha-3
fct_lead_organization Name of the organization(s) responsible
fct_year Year of publication
fct_language Language(s) of the FCT
fct_data_format Primary data type in which the information is provided (xlxs, pdf, csv )
fct_documentation Information about the data, within the dataset or as user guide, manuscript, etc. (yes or no)
fct_documentation_link link to the data and/or metadata
fct_licence Type of licence (i.e. CC, propietary, etc.)
fct_data_sources Source of data, i.e. other food composition tables, analyzed, etc. with number (n) or perc. (%) if available
fct_fooditem Number of food items
fct_component Number of nutrient and other components reported
fct_component_list List of nutrient and other components reported
moisture_in_g Analysis or method used  to calculate moisture (or water) content
energy_in_kcal Analysis or method used  to calculate energy (kcal)
energy_in_kj Analysis or method used  to calculate energy (kj)
nitrogen_in_g Analysis or method used  to calculate nitrogen
totalprotein_in_g Analysis or method used  to calculate protein
totalfats_in_g Analysis or method used  to calculate total fats
saturatedfa_in_g Analysis or method used  to calculate saturated fats
monounsaturatedfa_in_g Analysis or method used  to calculate monosaturated fats
polyunsaturatedfa_in_g Analysis or method used  to calculate polyunsaturated fats
cholesterol_in_mg Analysis or method used  to calculate cholesterol
carbohydrates_in_g Analysis or method used  to calculate carbohydrates
fibre_in_g Analysis or method used  to calculate fibre
ash_in_g Analysis or method used  to calculate ash
ca_in_mg Analysis or method used  to calculate calcium
fe_in_mg Analysis or method used  to calculate iron
mg_in_mg Analysis or method used  to calculate magnesium
p_in_mg Analysis or method used  to calculate phosphorus
k_in_mg Analysis or method used  to calculate potasium
na_in_mg Analysis or method used  to calculate sodium
zn_in_mg Analysis or method used  to calculate zinc
cu_in_mg Analysis or method used  to calculate copper
mn_in_mcg Analysis or method used  to calculate manganese
i_in_mcg Analysis or method used  to calculate iodine
se_in_mcg Analysis or method used  to calculate selenium (total, organic and inorganic)
vitamina_in_rae_in_mcg Analysis or method used  to calculate vitamin A as retinol active eq. [VITA_REA]
thiamin_in_mg Analysis or method used  to calculate thiamin
riboflavin_in_mg Analysis or method used  to calculate riboflavin
niacin_in_mg Analysis or method used  to calculate niacin
vitaminb6_in_mg Analysis or method used  to calculate vitamin B6
folicacid_in_mcg Analysis or method used  to calculate folic acid (synthetic folate)
folate_in_mcg Analysis or method used to calculate total folate
vitaminb12_in_mcg Analysis or method used  to calculate vitamin B12
pantothenate_in_mg Analysis or method used  to calculate pantothenate
biotin_in_mcg Analysis or method used  to calculate biotin
vitaminc_in_mg Analysis or method used  to calculate vitamin C
vitamind_in_mcg Analysis or method used  to calculate vitamin E
vitamine_in_mg Analysis or method used  to calculate vitamin E
phyticacid_in_mg Analysis or method used  to calculate phytate (total), phytic acid or Inositol phosphate 2-6
edible This variable contains information on the reporting of edible portion. Values can be reported as EDIBLE, REFUSE, INEDIBLE or NONE (no reported); Edible coefficient = "from whole to fillet/flesh"(EDIBLE1);  'from purchased to portion as consumed' (EDIBLE2)
edible_source If edible portion is repoted, source of the data
yieldfactor If yield factor is reported (yes or no)
yieldfactor_source If yield factor is repoted, source of the data
retentionfactor If retention factor is reported (yes or no)
retentionfactor_source If retention factor is repoted, source of the data
recipe_cal How the recipes were calculated: Ingredient method (i); Recipe method (recipe); Mixed method (m);  Raw ingredient method (r); Raw ingrediente corrected by weigh method (r-w); none
rbroth commented 3 years ago

Oh wait, hold on, I think I got confused. vitaminc_in_mg here doesn't refer to the micronutrient content of a fooditem, it refers to the analysis method for how the values were derived. In that case, I think a name like vitamina_in_rae_method would make more sense. Am I making sense? Apologies for wasting time.

LuciaSegovia commented 3 years ago

No problem! I'll change them tomorrow, could you check the fct_xxx names too, just in case I missed something? Thanks!

LuciaSegovia commented 3 years ago

Hi @rbroth, can we add an extra column to the metadata for the term ontology?

So it would be something like this:

Column Name Description CDNO
totalprotein_in_g Total Protein Content, in grams per 100g http://purl.obolibrary.org/obo/CDNO_0200040
spenny-liam commented 3 years ago

@LuciaSegovia Hi. The contents of these files are loaded into the database: MAPS_Eastern-Africa_v1.5.csv
MAPS_Southern-Africa_v1.5.csv MAPS_MAFOODS_v1.4.csv
MAPS_Western-Africa_v1.5.csv MAPS_Middle-Africa_v1.5.csv

However, i do not have any information on the FCT sources or citations for these. I think we still need to add in some columns as described above - do you have a csv of this?

LuciaSegovia commented 3 years ago

Hi @spenny-liam!

However, i do not have any information on the FCT sources or citations for these. I think we still need to add in some columns as described above - do you have a csv of this?

You mean "metadata" csv file? If yes, then you are right, I forgot to upload that one :) I'm adjusting the variables now and I'd upload it by the end of the day. Thanks!

LuciaSegovia commented 3 years ago

Hi @bgsandan,

I've realized that for the variable fct_documentation, it would be better to add the "citation" instead of being a Yes/No variable. What do you think?

rbroth commented 3 years ago

Hi @bgsandan,

I've realized that for the variable fct_documentation, it would be better to add the "citation" instead of being a Yes/No variable. What do you think?

Sounds like a good idea, possibly renamed it to something like fct_documentation_citation - "Citation for the user guide for this Food Composition table" fct_documentation_link - web url to the user guide for this Food Composition table