Eating And Health Module Atus
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EatingAndHealthModuleAtus | EatingAndHealthModuleAtusQueryParams | EatingAndHealthModuleAtusData |
Import Statement
from openbb_core.provider.standard_models. import (
EatingAndHealthModuleAtusData,
EatingAndHealthModuleAtusQueryParams,
)
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
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.