geosnap.io.get_ncdb

geosnap.io.get_ncdb(datastore, state_fips=None, county_fips=None, msa_fips=None, fips=None, boundary=None, years='all')[source]

Extract a subset of data from the Neighborhood Change Database (NCDB).

Parameters:
datastoregeosnap.DataStore

an instantiated DataStore object

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_fipslist or str

string or list of strings of fips codes defining MSAs to include in the study area.

fipslist or str

string or list of strings of five-digit fips codes defining counties to include in the study area.

boundarygeopandas.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 of ints

list of years (decades) to include in the study data (the default is all available [1970, 1980, 1990, 2000, 2010]).

Returns:
Community

long-form geodataframe with ‘year’ column representing each time period