ipumspy.ddi.Codebook

class ipumspy.ddi.Codebook(file_description, data_description, samples_description, ipums_citation, ipums_conditions, ipums_collection, ipums_doi)[source]

A class representing an XML codebook downloaded from IPUMS

Attributes

file_description

FileDescription object

data_description

list of VariableDescription objects

samples_description

list of IPUMS sample descriptions

ipums_citation

The appropriate citation for the IPUMS extract.

ipums_conditions

IPUMS terms of use

ipums_collection

IPUMS collection name

ipums_doi

"DOI of IPUMS data set

Methods

__init__

get_all_types

Retrieve all column types

get_variable_info

Retrieve the VariableDescription for an IPUMS variable

read

Read a Codebook from the parsed XML