eating_and_health_module_atus
Get ERS Eating and Health Module (ATUS) tables - time spent eating, drinking, in associated and secondary eating, preparing food, grocery shopping, and buying fast food, by demographic, food-security, and body-mass-index subgroups, each kept in its published wide layout for a selected survey release year.
Examples
from openbb import obb
obb.usda.eating_and_health_module_atus(provider='usda')
# Get the 2023 fast-food purchase frequency table.
obb.usda.eating_and_health_module_atus(table='fast_food_purchases', year='2023', provider='usda')
# Get 2022 food-related activity time by BMI group.
obb.usda.eating_and_health_module_atus(table='activities_by_bmi_group', year='2022', provider='usda')
Parameters
- standard
- usda
table: str | None
Default: eating_and_drinking_time
Description
Eating and Health Module table to retrieve. Each table is a single survey-year snapshot whose published measure-by-sex-by-statistic series ship pre-spread as the wide value columns, while the two leading dimensions stay as pinned row columns. Valid tables are:
eating_and_drinking_time, eating_time_by_subgroup, grocery_shopper_and_meal_preparer, fast_food_purchases, activities_by_grocery_responsibility, activities_by_meal_prep_responsibility, activities_by_food_security, activities_by_bmi_group
year: str | None
Default: 2023
Description
Release year selecting which survey-year snapshot to load. Valid years are:
2023, 2022
Returns
results: EatingAndHealthModuleAtus
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- usda
category: str
Leading survey dimension of the row, as published, e.g. the activity, response level, count of fast-food purchases, or BMI group.
subgroup: str
Second survey dimension of the row, as published, e.g. the age bracket, metropolitan status, gender, or breakdown question.
measure_type: str | None
Whether the fast-food row is an average count or a percent of purchasers. Populated only for the fast-food purchases table and null for every other table.