ipumspy.api.extract.define_extract_from_ddi

class ipumspy.api.extract.define_extract_from_ddi(ddi_codebook)[source]

Create a BaseExtract object from a parsed DDI codebook.

Parameters

ddi_codebook (Union[Codebook, List[Codebook]]) – A parsed IPUMS DDI Codebook object or list of such objects

Return type

Union[BaseExtract, List[BaseExtract]]

Returns

A BaseExtract object with the data collection, samples, variables, and data structure specified by the DDI Codebook. Data format defaults to fixed-width.