geosnap.data.Community.from_ncdb¶
-
classmethod
Community.
from_ncdb
(state_fips=None, county_fips=None, msa_fips=None, fips=None, boundary=None, years=[1970, 1980, 1990, 2000, 2010])[source]¶ Create a new Community from NCDB data.
Instiantiate a new Community from pre-harmonized NCDB data. To use you must first download and register LTDB data with geosnap using the store_ncdb function. Pass lists of states, counties, or any arbitrary FIPS codes to create a community. All fips code arguments are additive, so geosnap will include the largest unique set. Alternatively, you may provide a boundary to use as a clipping feature.
- Parameters
- state_fipslist or str
string or list of strings of two-digit fips codes defining states to include in the study area.
- county_fipslist or str
string or list of strings of five-digit fips codes defining counties to include in the study area.
- msa_fipstype
string or list of strings of fips codes defining MSAs to include in the study area.
- fipstype
string or list of strings of five-digit fips codes defining counties to include in the study area.
- boundary: geopandas.GeoDataFrame
geodataframe that defines the total extent of the study area. This will be used to clip tracts lazily by selecting all `GeoDataFrame.representative_point()`s that intersect the boundary gdf
- yearslist
list of years (decades) to include in the study data (the default is [1970, 1980, 1990, 2000, 2010]).
- Returns
- Community
Community with NCDB data