geosnap.io.store_ltdb

geosnap.io.store_ltdb(sample_zip=None, fullcount_zip=None, sample_paths=None, fullcount_paths=None, data_dir='auto', currency_year=2010)[source]

Read & store data from Brown’s Longitudinal Tract Database (LTDB).

Parameters:
sample_zipstr

file path of the zip file containing the standard Sample CSV files downloaded from https://s4.ad.brown.edu/projects/diversity/Researcher/LTBDDload/Default.aspx

fullcount_zip: str

file path of the zip file containing the standard Fullcount CSV files downloaded from https://s4.ad.brown.edu/projects/diversity/Researcher/LTBDDload/Default.aspx

sample_paths: dict

dictionary of CSV files (e.g. if manually unzipping the archive from LTDB). The dict should be formatted using sample_{year} as the key, with the value storing the path to the given csv, as in {‘sample_1970’: ‘path/to/sample_1970.csv’,}

fullcount_paths: dict

dictionary of CSV files (e.g. if manually unzipping the archive from LTDB). The dict should be formatted using fullcount_{year} as the key, with the value storing the path to the given csv, as in {‘fullcount_1970’: ‘path/to/fullcount_1970.csv’,}

data_dir: str

directory to store the resulting parquet file. If ‘auto’ (default) the default geosnap data directory will be used (via the platformdirs package)

currency_yearint

year used to express common dollar values. Default is 2010 meaning all currency variables (e.g. median income) will be expressed in real 2010 values.

Returns:
None