area_and_road_ruggedness_scales

Get ERS area and road ruggedness scales - census-tract Area Ruggedness Scale (ARS) and Road Ruggedness Scale (RRS) classifications with terrain ruggedness statistics, rurality, and population, as a single-vintage geographic lookup table scoped by State.

Examples

from openbb import obb
obb.usda.area_and_road_ruggedness_scales(provider='usda')
# Get the 2020 area and road ruggedness scales for Colorado census tracts.
obb.usda.area_and_road_ruggedness_scales(vintage='2020', state='CO', provider='usda')
# Get the 2010 vintage for West Virginia census tracts.
obb.usda.area_and_road_ruggedness_scales(vintage='2010', state='WV', provider='usda')

Parameters

• standard
• usda

vintage: str | None
Default: 2020

Description

Census-tract vintage to retrieve, selecting the source file. Each vintage is a separate census-tract lookup carrying the Area Ruggedness Scale (ARS) and Road Ruggedness Scale (RRS) classifications and their terrain statistics. Valid vintages are:
2020, 2010

state: str | None
Default: WV
State to retrieve, as a two-letter postal abbreviation. The census-tract lookup carries tens of thousands of rows, so the state is the primary scope filter. If None, defaults to West Virginia.

---

Returns

results: AreaAndRoadRuggednessScales

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

tract_fips: str
Eleven-digit census-tract FIPS code, with leading zeros preserved.

tract_name: str | None
Census-tract name, as published.

county_fips: str | None
Five-digit county FIPS code, with leading zeros preserved.

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

state_fips: str | None
Two-digit state FIPS code, with a leading zero preserved.

state: str
Two-letter state or district postal code.

state_name: str | None
Full state or district name.

rs_region: str | None
Ruggedness-Scale region code, 1 to 12.

rs_region_name: str | None
Ruggedness-Scale region name, one of the twelve regions the ARS and RRS thresholds are calibrated within.

primary_ruca: str | None
Primary Rural-Urban Commuting Area (RUCA) code, 1 to 10, with 99 marking a water tract.

rurality_code: str | None
Rurality code, 1 to 3, with 99 marking a tract without a rurality code.

rurality_name: str | None
Rurality name: Urbanized area, Urban commuting, Rural, or no rurality code.

population: int | None
Census-tract population, as a full count.

land_area: float | None
Census-tract land area, in square miles.

pop_density: float | None
Population density, in persons per square mile.

area_tri_count: int | None
Count of terrain ruggedness index (TRI) grid cells summed over the tract's area.

area_tri_mean: float | None
Mean area terrain ruggedness index over the tract, in meters.

area_tri_std_dev: float | None
Standard deviation of the area terrain ruggedness index over the tract, in meters.

area_tri_median: float | None
Median area terrain ruggedness index over the tract, in meters.

area_tri_min: float | None
Minimum area terrain ruggedness index over the tract, in meters.

area_tri_max: float | None
Maximum area terrain ruggedness index over the tract, in meters.

area_tri_range: float | None
Range of the area terrain ruggedness index over the tract, in meters.

ars: str | None
Area Ruggedness Scale code, 1 to 6, from 1 Level to 6 Extremely rugged.

ars_description: str | None
Area Ruggedness Scale description for the code.

road_tri_count: int | None
Count of terrain ruggedness index (TRI) grid cells sampled along the tract's roads.

road_tri_mean: float | None
Mean road terrain ruggedness index over the tract, in meters.

road_tri_std_dev: float | None
Standard deviation of the road terrain ruggedness index over the tract, in meters.

road_tri_median: float | None
Median road terrain ruggedness index over the tract, in meters.

road_tri_min: float | None
Minimum road terrain ruggedness index over the tract, in meters.

road_tri_max: float | None
Maximum road terrain ruggedness index over the tract, in meters.

road_tri_range: float | None
Range of the road terrain ruggedness index over the tract, in meters.

rrs: str | None
Road Ruggedness Scale code, 1 to 5, from 1 Level to 5 Highly rugged.

rrs_description: str | None
Road Ruggedness Scale description for the code.