ipumspy.api.BaseExtract.attach_characteristics#

BaseExtract.attach_characteristics(variable, of)[source]#

A method to update existing IPUMS Extract Variable objects with the IPUMS attach characteristics feature.

Parameters:

variable (Union[Variable, str]) – a Variable object or a string variable name
of (List[str]) – a list of records for which to create a variable on the individual record. Allowable values include “mother”, “father”, “spouse”, “head”. For IPUMS collection that identify same sex couples can also accept “mother2” and “father2” values in this list. If either “<parent>” or “<parent>2” values are included, their same sex counterpart will automatically be included in the extract.