ipumspy.api.BaseExtract#

class ipumspy.api.BaseExtract[source]#

A wrapper around an IPUMS extract. In most cases, you probably want to use a subclass, but if a particular collection does not have an Extract currently built, you can use this wrapper directly.

Attributes

`extract_id`	The extract id associated with this extract, assigned by the `IpumsApiClient`
`extract_info`	The API response recieved by the `IpumsApiClient`

Methods

`__init__`	A wrapper around an IPUMS extract.
`add_data_quality_flags`	A method to update existing IPUMS Extract Variable objects to include that variable's data quality flag in the extract if it exists.
`attach_characteristics`	A method to update existing IPUMS Extract Variable objects with the IPUMS attach characteristics feature.
`build`	Convert the object into a dictionary to be passed to the IPUMS API as a JSON string
`extract_api_version`	rtype: `str`
`select_cases`	A method to update existing IPUMS Extract Variable objects to select cases with the specified values of that IPUMS variable.