ipumspy.api.extract.define_extract_from_json

class ipumspy.api.extract.define_extract_from_json(filename)

Convenience method to convert an IPUMS extract definition or definitions stored in a json file into a BaseExtract object. If multiple extracts are specified, return a List[BaseExtract] objects.

Parameters:

filename (str) – Json file containing IPUMS extract definitions

Return type:

Union[BaseExtract, List[BaseExtract]]

Returns:

The extract(s) specified in the json file