natural_amenities_scale

Get ERS natural amenities scale - a county-level measure of the physical characteristics that make a location a desirable place to live, combining six standardized climate, topography, and water-area components into a composite amenity scale and a 1-to-7 rank, as a one-row-per-county FIPS lookup scoped by state.

Examples

from openbb import obb
obb.usda.natural_amenities_scale(provider='usda')
# Get the natural amenities scale for Rhode Island counties.
obb.usda.natural_amenities_scale(state='RI', provider='usda')
# Get the natural amenities scale for California counties.
obb.usda.natural_amenities_scale(state='CA', provider='usda')

Parameters

• standard
• usda

state: str | None
Two-letter state postal abbreviation to scope the county rows to a single state. If None, returns every county. The scale covers the 48 contiguous states and the District of Columbia; Alaska, Hawaii, and the territories are not scored.

---

Returns

results: NaturalAmenitiesScale

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

fips: str
County FIPS code, five digits with a leading zero.

fips_used_for_measures: str | None
County FIPS whose measures this row carries, equal to the FIPS code except for the 41 combined areas whose measures are reported under a neighboring county.

state: str | None
Two-letter state postal abbreviation.

county_name: str | None
County or county-equivalent area name, as published.

census_division: str | None
Census division code, 1 to 9.

rural_urban_continuum_code: str | None
Rural-Urban Continuum (Beale) code, 1993 vintage.

urban_influence_code: str | None
Urban Influence Code, 1993 vintage.

mean_january_temperature: float | None
Mean January temperature in degrees Fahrenheit, 1941-70.

mean_january_sunlight: float | None
Mean hours of January sunlight, 1941-70.

mean_july_temperature: float | None
Mean July temperature in degrees Fahrenheit, 1941-70.

mean_july_humidity: float | None
Mean relative July humidity in percent, 1941-70.

topography_code: str | None
Land surface form topography code, 1 to 21.

percent_water_area: float | None
Water area as a percent of the county's total area.

log_water_area: float | None
Natural log of the county's water area times 100.

january_temperature_z: float | None
Standardized Z-score of the mean January temperature.

january_sunlight_z: float | None
Standardized Z-score of the mean January sunlight.

july_temperature_z: float | None
Standardized Z-score of the mean July temperature.

july_humidity_z: float | None
Standardized Z-score of the mean July humidity, inverted so that lower humidity scores higher.

topography_z: float | None
Standardized Z-score of the topography code.

log_water_area_z: float | None
Standardized Z-score of the log water area.

natural_amenity_scale: float | None
Composite natural amenity scale, the sum of the six standardized Z-scores.

natural_amenity_rank: str | None
Natural amenity rank derived from the scale, 1 for the lowest amenity through 7 for the highest.