Food Consumption Nutrient Intakes And Diet Quality
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FoodConsumptionNutrientIntakesAndDietQuality | FoodConsumptionNutrientIntakesAndDietQualityQueryParams | FoodConsumptionNutrientIntakesAndDietQualityData |
Import Statement
from openbb_core.provider.standard_models. import (
FoodConsumptionNutrientIntakesAndDietQualityData,
FoodConsumptionNutrientIntakesAndDietQualityQueryParams,
)
Parameters
- standard
- usda
table: str | None
Default: 2_nutrient_intake
Description
Table to retrieve. Tables 1-7 are a 1977-2018 survey-cycle series, pivoted with the survey cycles as columns; Table 8 pivots the recommended and 2017-2018 actual densities into columns. Valid tables are:
1_sample_sizes, 2_nutrient_intake, 3_nutrient_intake_share, 4_nutrient_density, 5_food_group_intake, 6_food_group_intake_share, 7_food_group_density, 8_recommended_vs_actual_density
demographics: str | None
Default: US consumers aged 2 and above
Description
Population subgroup filter for the intake tables (2-7), keeping the survey-cycle columns to a single subgroup. Ignored by the sample-size table (1), which lists every subgroup, and by the recommended-density table (8). Valid subgroups are:
US consumers aged 2 and above, Sex - Males, Sex - Females, Ages 2-19, Ages 20-64, Ages 65 and above, Cohort - Boys age 2-19, Cohort - Girls age 2-19, Cohort - Men age 20 and above, Cohort - Women age 20 and above, Income - low-income households, Income - mid-income households, Income - high-income households, Race - Non-Hispanic White, Race - Non-Hispanic Black, Race - Hispanic, Race - Other racial & ethnic, Edu. - Less than high school, Edu. - High school degree, Edu. - College attended
statistic: str | None
Default: mean
Description
Statistic to spread across the survey-cycle columns for the intake tables (2-7): the mean, or the standard error of the mean. Ignored by the sample-size and recommended-density tables. Valid statistics are:
mean, se_of_mean
start_year: int | None
Start year for filtering the survey-cycle columns, compared against the first year of each cycle. Ignored by the recommended-density table. If None, returns from 1977.
end_year: int | None
End year for filtering the survey-cycle columns, compared against the first year of each cycle. Ignored by the recommended-density table. If None, returns through 2017-2018.
Data
- standard
- usda
item: str
Row identity: the nutrient (Tables 2-4, 8), food group (Tables 5-8), or population subgroup (Table 1), as published. On the intake tables (2-7) the food source is appended, e.g. 'Energy — FAH', because each nutrient repeats once per food source.
food_source: str | None
Food source of the observation for the intake tables (2-7): Total, food at home (FAH), food away from home (FAFH), or an FAFH outlet. Already folded into the item label; kept as a separate toggleable column. None for the sample-size and recommended-density tables.
units: str | None
Unit of the row's values, as published, e.g. 'Calories', 'Grams', 'Percent of total', or 'Grams per 1,000 calories'. None for the sample-size table and where a unit is carried in the item label instead.