Food Dollar Series
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
FoodDollarSeries | FoodDollarSeriesQueryParams | FoodDollarSeriesData |
Import Statement
from openbb_core.provider.standard_models. import (
FoodDollarSeriesData,
FoodDollarSeriesQueryParams,
)
Parameters
- standard
- usda
series: str | None
Default: nominal
Series to retrieve, selecting the source dataset. 'nominal' is current-year dollars with the full primary-factor decomposition and all 22 tables; 'real' is inflation-adjusted 2017 dollars with only the six food-dollar aggregate tables.
units: str | None
Default: share
Units of the cell values. 'share' is cents per domestic food dollar; 'level' is millions of dollars. Orthogonal to series.
component: str | None
Default: total
Description
Primary-factor component that fills the cells. Valid components depend on series; for nominal:
total, salary_and_benefits, property_income, output_taxes, imports
for real:
total, value_added, imports
'total' is populated for every year and category.
table: int | None
Default: 1
Food-dollar table to retrieve, by table number. Nominal offers tables 1-22 (six dollar aggregates and 16 commodity groups); real offers only tables 1-6.
start_year: int | None
Start year for filtering the data. If None, returns from the series' first year.
end_year: int | None
End year for filtering the data. If None, returns up to the most recent year.
Data
- standard
- usda
industry_group: str
Marketing-bill industry group or aggregate, as published, e.g. 'Farm production', 'Foodservices', or 'Farm share'.