pycancensus.as_census_region_list

pycancensus.as_census_region_list(tbl: DataFrame) dict[source]

Convert a (suitably filtered) DataFrame from list_census_regions() to a regions dict suitable for passing to get_census().

Parameters:

tbl (pd.DataFrame) – A data frame, suitably filtered, as returned by list_census_regions().

Returns:

Mapping of aggregation level to list of region identifiers, e.g. {“CSD”: [“5915022”, “3520005”]}.

Return type:

dict

Examples

>>> import pycancensus as pc
>>> regions = pc.list_census_regions("CA16")
>>> csds = regions[regions["level"] == "CSD"].head(20)
>>> data = pc.get_census("CA16", regions=pc.as_census_region_list(csds),
...                      vectors=["v_CA16_408"], level="Regions")