ipumspy.ddi.VariableDescription

class ipumspy.ddi.VariableDescription(id, name, codes, start, end, label, description, concept, vartype, shift)[source]

Individual variables are described in the DDI. These are representations of those descriptions as dataclasses.

Attributes

numpy_type

The Numpy type of this variable.

pandas_type

The Pandas type of this variable.

pandas_type_efficient

In contrary to self.pandas_type, self.pandas_type_efficient doesn't implement "Int64" type but "numpy.float64" for integer type.

python_type

The Python type of this variable.

id

variable id (this is the same as its name)

name

variable name

codes

a dictionary of codes and value labels

start

variable's starting column in the extract data file

end

variable's final column in the extract data file

label

variable label

description

variable description

concept

IPUMS variable group

vartype

variable data type

shift

number of implied decimal places

Methods

__init__

read

Read an XML description of a variable.