ipumspy.api.Variable#

class ipumspy.api.Variable(name, preselected=False, case_selections=<factory>, attached_characteristics=<factory>, data_quality_flags=False, adjust_monetary_values=False)[source]#

IPUMS variable object to include in a MicrodataExtract object.

Parameters:

name (str) – IPUMS variable name
case_selections (Optional[Dict[str, List]]) – Case selection specifications
attached_characteristics (Optional[List[str]]) – Attach characteristics specifications
data_quality_flags (Optional[bool]) – Flag to include the variable’s associated data quality flags if they exist
adjust_monetary_values (Optional[bool]) – Flag to include the variable’s associated inflation-adjusted equivalent, if possible

Attributes

`adjust_monetary_values`	Flag to include the variable's associated inflation-adjusted equivalent, if possible
`data_quality_flags`	Flag to include the variable's associated data quality flags if they exist
`preselected`	Whether the variable is preselected.
`name`	IPUMS variable name
`case_selections`	Case selection specifications
`attached_characteristics`	Attach characteristics specifications

Methods

`__init__`
`build`	Format Variable information for API Extract submission